Skip to content

Fix typo in readme #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typo in readme #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The items you want to pay attention are:
|--------------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `basePath` | `/` | the base path of your org-mode content, e.g. `/blog` |
| `contentPath` | `content` | source folder of your org files, relative to the root of the project. e.g. `../notes` |
| `filter` | `{}` | filter of your posts, key sohuld match metadata property names, e.g. `{ category: 'posts'}` |
| `filter` | `{}` | filter of your posts, key should match metadata property names, e.g. `{ category: 'posts'}` |
| `pagination` | 10 | maximum number of posts per index page. |
| `slug` | `['$category', '$export_file_name']` | array of elements for generating slug for each posts, the ones with `$` prefix means to take the value from metadata with matching field name, e.g. `['blog', '$export_file_name']` will give you slugs like `blog/my-post` |
| `buildIndexPage` | `true` | whether or not to build an index page, it's path would be your `basePath`, but can be overwritten by custom pages in your `src/pages` folder. |
Expand Down