Comments (1)
Here are the rules we should go for:
- rule 1: we keep the prefix
_
rule : files starting with_
will be ignored (ie. next-markdown won't create a path for it). It allows to easily publish / unpublish a page - rule 2: in a given folder, every files (except
index.md
) will be listed in theindex.md
rendered page. - rule 3: if any, text within the brackets at the beginning of the file (but after
_
see rule 1) will be ignored (eg: file[feat1]hello_world.md
will create/hello_world
)
Note: having bracket is totally optional (cf. rule 2)
Examples, resulting to the same behavior
brackets | |
---|---|
![]() |
![]() |
The index.md
rendered page will received props:
props: {
...
posts: [
{
...
nextmd: [docs, get-started]
},
{
...
nextmd: [docs, blog-aware]
},
{
...
nextmd: [docs, dynamic-routes]
},
{
...
nextmd: [docs, table-of-contents]
},
{
...
nextmd: [docs, examples]
},
{
...
nextmd: [docs, contributing]
},
]
What if I don't want a file to be listed?
Answer: create a folder; cf. rule 2: only files will be listed in the index.md
rendered page.
In the following example, /docs/contribution
will not be listed in the rendering of /docs
from next-markdown.
Related Issues (8)
- feat (advanced): allow to flatten some directories for docs / blog classification purpose
- feat: optional catch all routes HOT 1
- load page error HOT 2
- feat: support mdx
- feat: allow building docs style pages HOT 5
- Setup the project so it's easy to develop and test this nextjs library HOT 3
- feat (advanced): split next-markdown into smaller modules HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from next-markdown.