From 18533d8d8b85460e9b1426c935f765f7de7f5c53 Mon Sep 17 00:00:00 2001 From: Chris Palmer Date: Wed, 12 Jun 2019 12:21:42 +0100 Subject: [PATCH] Fixed code block to work on local markdown. --- docs/usage.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index cd55143..9cde0e2 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -15,6 +15,7 @@ The following Python modules are used and can be installed with pip: ``` pip install colorama pip install codespell +pip install markdown ``` ## Installation @@ -51,23 +52,19 @@ Each project has its own directory and that is used to derive the project's name assembly. A skeleton project looks like this: - + //! Project description in Markdown format before the first include. + include -``` -//! Project description in Markdown format before the first include. -include - -... - -//! Assembly instructions in Markdown format in front of each module that makes an assembly. -module main_assembly() -assembly("main") { ... -} -if($preview) - main_assembly(); + //! Assembly instructions in Markdown format in front of each module that makes an assembly. + module main_assembly() + assembly("main") { + ... + } -``` + if($preview) + main_assembly(); Other scad files can be added in the scad directory and included or used as required.