Samyoul / EspruinoDocs

Tutorials, Projects and Example code from the Espruino Website

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

EspruinoDocs

Espruino Documentation and Code

This is basically GitHub Markdown but it goes through a script which looks for the following (on the start of a line):

* KEYWORDS: Comma,Separated,List ; Defines keywords for this file
* APPEND_KEYWORD: Keyword        ; Append a list of pages that match the keyword

It also looks for a title (second line, after copyright notices) which it uses to create the title of the HTML page (and of links to it).

There are a few extra bits too:

  • [[My Page]] links to a page on the Espruino website
  • [[http://youtu.be/VIDEOID]] puts a video on the page
  • ![Image Title](foo.png) Adds an image. Images should be in a directory named after the filename of the file referencing them

It then converts the markdown to HTML and shoves it on the Espruino website. lovely.

Building

sudo apt-add-repository ppa:richarvey/nodejs
sudo apt-get update

sudo apt-get install npm nodejs
#npm install marked pygmentize-bundled --save
npm install marked highlight.js --save

About

Tutorials, Projects and Example code from the Espruino Website

License:Other