add config for directories

crystal-linux · Sep 13, 2022 · 59e6cb1 · 59e6cb1
1 parent b9d3006
commit 59e6cb1
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 6 deletions.
diff --git 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
@@ -0,0 +1 @@
+title: Amethyst
diff --git a/Amethyst/config.mdx → amethyst/config.mdx b/Amethyst/config.mdx → amethyst/config.mdx
diff --git a/Amethyst/usage.mdx → amethyst/usage.mdx b/Amethyst/usage.mdx → amethyst/usage.mdx
diff --git a/malachite/.config.yaml b/malachite/.config.yaml
@@ -0,0 +1 @@
+title: Malachite
diff --git a/Malachite/common-features.mdx → malachite/common-features.mdx b/Malachite/common-features.mdx → malachite/common-features.mdx
diff --git a/Malachite/usage.mdx → malachite/usage.mdx b/Malachite/usage.mdx → malachite/usage.mdx