32cf426956
Currently, page url generation (slugification) is just toLowerCase. In https://github.com/yannbertrand/macos-defaults/pull/146 I add some defaults that contain keys with spaces, which currently breaks. This pulls in `slugify` to add support, and shell escapes keys in examples. |
||
---|---|---|
.github | ||
.vscode | ||
build | ||
images | ||
record | ||
.gitignore | ||
.prettierignore | ||
.prettierrc | ||
CODE_OF_CONDUCT.md | ||
defaults-fr.yml | ||
defaults.schema.json | ||
defaults.yml | ||
license | ||
readme.md |
Welcome to macOS-defaults 👋
Stability: 1 - Experimental
defaults
commands allow you to programmatically set System Settings of your Mac. 🤖⚙️🔧An up-to-date list of macOS
defaults
commands with demos. ✨
Add a command
All the listed defaults
commands are stored in localized defaults*.yml files. Here is how a command's info is designed:
- key: the-command-name-separated-with-dashes # The command's key
domain: com.some-domain.app-name # The command's domain
title: My command
description: Explaining what my command does.
param:
type: bool # Other types can be used
examples: # A list of examples
- value: false # This example sets the value to `false`
default: true # `false` is the default value of the command
image: # Optional: an auto recorded screenshot
filename: "false.png"
width: 800
height: 600
text: Explaining what happens when the command is set to `false`
- value: true # This one sets the value to `true`
image:
filename: "true.png" # The name of the image
width: 800 # The width of the image
height: 600 # And its height
text: Explaining what happens when the command is set to `true`
versions: [Big Sur, Catalina] # It's been tested on Big Sur and Catalina
You can validate these files locally using the provided JSON schema using the VSCode YAML Language support extension or on the CLI with:
npx pajv validate -s defaults.schema.json -d defaults.yml
Images and videos are built programmatically. Take a look at the record folder to find out how to record some. I will always prefer images and videos examples as they help maintenance a lot! Please consider it if you want to open a PR.
macOS-defaults builder 🤖
Compare Static Site Generators by automatically building websites from this yaml file content 🏗.
It currently builds to:
GitHub Flavored Markdown | VuePress | Docusaurus | docsify |
latest | 1.6.0 | 1.14.6 | latest |
Features
/ | GitHub | VuePress | Docusaurus | docsify |
---|---|---|---|---|
Stars ⭐️ | N/A | |||
No JS needed | ✅ | ✅ | ✅ | ❌ |
Code highlight | ✅ docs |
✅ docs (Prism.js) |
✅ docs (Highlight.js) |
✅ docs (plugin Prism.js) |
Search | ✅ | ✅ | ❌ | ✅ (plugin) |
Video support | ❌ | ✅ | ✅ | ✅ |
Official themes | 1 | 1 | 1 | 4 |
Netlify build time | N/A | 57s | 1m 1s | 38s |
Click to copy code | ❌ | ❌ | ❌ | ✅ (plugin) |
Category page | ✅ | ✅ | ❌ | ✅ |
Default port | N/A | 8080 | 3000 | 3000 |
How does it work?
- See GitHub's build detail
- See VuePress' build detail
- See Docusaurus' build detail
- See Docsify's build detail
macOS-defaults recorder 📷
Programmatically record a Mac screen with a predefined list of actions 📹.
The project also contains scripts that run desktop actions, take screenshots or record videos. The goal is to avoid having to manually recheck the status of commands with each new major version of macOS.
How does it work?
Take a look at the record folder if you want to go deeper.
Show your support
Give a ⭐️ if this project helped you!
This README was generated with ❤️ by readme-md-generator