diff --git a/.github/README.md b/.github/README.md index a243ed0..ff354b4 100644 --- a/.github/README.md +++ b/.github/README.md @@ -23,15 +23,34 @@ title: An Important Entry Content ``` -## Filenames +## Entry Config -Use Kebab case for filenames -| ❌ | ✅ | -| :------------------: |:--------------------:| -| `an_important_entry` | `an-important-entry` | +```yaml +--- +title: string +weight: number +--- +``` + +#### `title` + +A pretty title that will be displayed to the user. -Ignore for directories for now +#### `weight` + +Entries and files are sorted by their weights. Higher number = Higher up. + +## File and directory names + +Use Kebab case for filenames +| ❌ | ✅ | +| - | - | +| `an_important_entry.mdx`, `An Important Entry.mdx` | `an-important-entry.mdx` | ## Directories Do not create directories any deeper than 1. Only top level directories for different projects. + +### `.config.yaml` + +Create a .config.yaml for every directory. See [Entry Config](#entry-config) diff --git a/amethyst/.config.yaml b/amethyst/.config.yaml new file mode 100644 index 0000000..2b95f90 --- /dev/null +++ b/amethyst/.config.yaml @@ -0,0 +1 @@ +title: Amethyst diff --git a/Amethyst/config.mdx b/amethyst/config.mdx similarity index 100% rename from Amethyst/config.mdx rename to amethyst/config.mdx diff --git a/Amethyst/usage.mdx b/amethyst/usage.mdx similarity index 100% rename from Amethyst/usage.mdx rename to amethyst/usage.mdx diff --git a/malachite/.config.yaml b/malachite/.config.yaml new file mode 100644 index 0000000..88ca52b --- /dev/null +++ b/malachite/.config.yaml @@ -0,0 +1 @@ +title: Malachite diff --git a/Malachite/common-features.mdx b/malachite/common-features.mdx similarity index 100% rename from Malachite/common-features.mdx rename to malachite/common-features.mdx diff --git a/Malachite/usage.mdx b/malachite/usage.mdx similarity index 100% rename from Malachite/usage.mdx rename to malachite/usage.mdx