Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
docs
src
utils
.gitignore
.prettierrc
LICENSE
README.md
gatsby-browser.js
gatsby-config.js
gatsby-node.js
gatsby-ssr.js
gatsby-thoughts.md
index.js
package.json
test.html

README.md

gatsby-theme-mdxbook

A Gatsby theme designed to replicate the Gitbook reading experience, but with all the power of Gatsby development instead.

Required

  • README.md

Optional

  • SUMMARY.md - If provided, will be used to generate the table of contents (sidebar) of the site. Otherwise, will infer from directory structure.

Missing

  • Glossary

Flow

  • Check if README.md exists for Home page (REQUIRED)
  • Check if SUMMARY.MD exists to setup sidebar
    • if exists, loop through this data to create pages
    • otherwise, loop through folders to create it