add config for directories

pull/4/head
mrshmllow 2 years ago committed by marshmallow
parent 75a94bac5a
commit bd8e47cb3a

29
.github/README.md vendored

@ -23,15 +23,34 @@ title: An Important Entry
Content Content
``` ```
## Filenames ## Entry Config
```yaml
---
title: string
weight: number
---
```
#### `title`
A pretty title that will be displayed to the user.
#### `weight`
Entries and files are sorted by their weights. Higher number = Higher up.
## File and directory names
Use Kebab case for filenames Use Kebab case for filenames
| ❌ | ✅ | | ❌ | ✅ |
| :------------------: |:--------------------:| | - | - |
| `an_important_entry` | `an-important-entry` | | `an_important_entry.mdx`, `An Important Entry.mdx` | `an-important-entry.mdx` |
Ignore for directories for now
## Directories ## Directories
Do not create directories any deeper than 1. Only top level directories for different projects. 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)

@ -0,0 +1 @@
title: Amethyst

@ -0,0 +1 @@
title: Malachite
Loading…
Cancel
Save