Skip to content

Development Notes

Add Quick-Note button

Button Rendering

I copied the file partials/header.html from the MkDocs theme and modified in order to add the quick-note button to its structure.

The CSS and JS necessary to make it work are both contained in the same file.

Button image

The button image is part of the assets folder of the index page. It is located in templates/material-index.

Add Quick-Note page

This is another page located at templates/material-index/default-pages/add-quick-note.html

This page is rendered when the add quick-note button is clicked. It is accessed via an url in the following format: http://journals.barriguinhas.fr/<JOURNAL_NAME>/quick-note/add. The <JOURNAL_NAME> is captured by the node.js handler of this URL to set up the proper action of the send button.

Add Quick-Note action

The action is coded in the init.js file of the http server.