0.1.0 • Published 4 years ago

gatsby-markbook v0.1.0

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

Personal Markdown Book

This is modified from gatsby-default-starter. Support some features I required for lots of my markdown key note files.

  • LaTeX (with KaTeX & gatsby-remark-mathjax, no server rendering thougth)
  • Graphviz (gatsby-transformer-graphviz)
  • Using Typography.js Themes (https://kyleamathews.github.io/typography.js/)
  • Code Highlight (gatsby-remark-vscode)
  • A simple filter to find the markdown pages by keyword. It's important for ppl like me who got tons of markdown files as notes.

Demo Site : https://markbook.netlify.com

Screen Shots

Code Highlight npm.io

Graphviz npm.io

LaTeX npm.io

Main Page (My tons of markdown key note files...) npm.io

Netlify Deployment

Netlify Status

  1. Fork this repository to your own account.
  2. Goto https://app.netlify.com/ and click on New Site from Git button.
  3. Choose the forked respository and deploy it. (All default setting is good.)
  4. Wait for 2min and 32 seconds, your site is live just like my demo site above.

Local Installation

npm install
npm install -g gatsby-cli

gatsby develop
     or
gatsby build
gatsby serve

Test

  1. Browse http://localhost:8000/
  2. Click on test (which is src/pages/test.md)
  3. Check src/pages/test.md for the usage example for LaTeX, Graphviz and code highlight.
  4. Put your .md files to src/pages/ and they would be presented right away.