Skip to content

Latest commit

 

History

History
145 lines (98 loc) · 5.04 KB

README.md

File metadata and controls

145 lines (98 loc) · 5.04 KB
Raw

Boostnote Vuepress Notes Repo

Although, boostnote is good for taking notes,it lacks wiki-like and search functionality, especically for large amounts of markdown files, in order to view the notes, you must first install boostnote, so it lacks portable.

Since both boostnote and vuepress are built on top of markdown-it, transferring the exported markdown content bewteen formats is simplifer than expected. Interesting, boostnote also uses stylus files, which are available in vuepress as well.

Summary

  1. Clone or fork the repo
  2. Create Boostnote storage in root
  3. Modify config.js under docs/.vuepress/, replace base with github directory, repo information with your username, etc .../

and if you aren't serving the app from root, config the relative urls in override.styl like so,

@font-face {
  font-family: 'Material Icons';
  font-style: normal;
  font-weight: 400;
  src: url(/markdown-notes-template/fonts/MaterialIcons-Regular.eot); /* For IE6-8 */
  src: local('Material Icons'),
    local('MaterialIcons-Regular'),
    url(/markdown-notes-template/fonts/MaterialIcons-Regular.woff2) format('woff2'),
    url(/markdown-notes-template/fonts/MaterialIcons-Regular.woff) format('woff'),
    url(/markdown-notes-template/fonts/MaterialIcons-Regular.ttf) format('truetype');
}

How to use

Obviously, one must have boostnote installed, with the storage pointed to the root directory.

Additionally, vuepress must be installed globally.

npm install --global vuepress

Or one can install the dependencies like so

Install the dependencies

pip -r requirements.txt
yarn install

What does this template do

Running the python script boostNote2Md.py transfers notes from boostnote into a selected directory

python boostNote2Md.py -s notes -o docs

Then extract all the notes and run vuepress

python boostNote2Md.py
yarn docs:dev

Why Vuepress and Boostnote-notes-repo

  • They both use Markdown-it
  • Plugins are similar
  • Publishing a folder of boostnote notes is difficult

Currently, if you have images in your boostnote notes, export the entire directory (images will be stored as attachments).

Automatic builds via gitlab, using a two stage pipeline, one can convert boostnote notes to vuepress documentation deployed to either gitlab pages or github pages or netlify.

Vuepress Plugins

VuePress currently uses the following markdown-it plugins:

  • markdown-it-anchor
  • markdown-it-container
  • markdown-it-emoji
  • markdown-it-table-of-contents Its style files (apparently in Stylus format) are probably worth looking at, too.

Boostnote plugins

The boostnote plugins that are different are most likely

  • markdown-it-task-lists
  • markdown-it-katex
  • markdown-it-plantuml
  • markdown-it-admonitions
  • markdown-it-footnotes
  • markdown-it-kbd (don't know official name)

Other functionality of Boostnote

Some things are hard to replicate precisely using Vuepress for example the chart.js support in boostnote.

A good approximatation is markdown-it-charts and cdning the dependencies.

Limitations

The markdown-it katex plugin is a few versions behind the latest katex version.

Transfering images from boostnote to vuepress may be challenging, but we will see how it goes, and katex may be outdated.

Some plugins are missing such as markdown-it-footnote and markdown-it-kbd

Boostnote snippets are not transferred, simplish to fix.

A list of tasks and links, research completed in BoostNote

Can also write about how I tried out a lot of documentation formats, but boostnote + vuepress is a good combo.

If one is using gitlab to build the project, custom variables must be set.

Could improving automatic sidebar and navbar generation (detect if no README.md note is present etc ../)

Markdown-it plugins

Todo

  • Add chartjs support, based on boostnote support?
  • Sample project configure for IOT, and other things.
  • improve python script to read boostnote snippters
  • continuous deployment with gitlab
  • Think about latex integration, probably best to export to html and then convert to latex, or remove the !!! through scripting. (replace !!! note) with a environment, etc .. (using pandoc-admonition plugin which works as long as a yaml header is included, but fails to read !!!, could try using ::: format instead.

Add latex conversion, hard to get solidity code in there.

pandoc --from markdown+definition_lists+table_captions+multiline_tables+grid_tables+pipe_tables+pandoc_title_block --filter=pandoc-latex-admonition test.md --to latex -o testing56.tex
References

vuejs/vuepress#613

Missing components

Use the package at

https://github.com/johannbre/markdown-it-admonition

To match the boostnote style, I should be able to use both.

Same idea as https://www.npmjs.com/package/@iktakahiro/markdown-it-katex

and https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a

Contribution

Any suggestions for improvement are welcome.