Coder Social home page Coder Social logo

Comments (1)

frouo avatar frouo commented on July 21, 2024

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 the index.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
image image

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

image

from next-markdown.

Related Issues (8)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.