JtD OpenSCAD Template
Welcome to the JtD OpenSCAD Template documentation!
Overview
This landing page should give:
- One-sentence elevator pitch of your project.
- Badges (build status, version, license, etc.).
- A very brief “What’s in this docs” overview.
- Links to direct users to key sections:
Tips & Tricks
Below are a few of the built-in Just the Docs UI components you can sprinkle into your docs.
Buttons
Use the .btn class on any link to turn it into a nicely styled button:
Labels
Draw attention to status or categories with colored labels:
Stable Beta Experimental
Callouts
Highlight notes, tips or warnings using blockquotes:
These settings are experimental.
Or chose from the many built-in stylized callouts:
An untitled callout:
A paragraph
A single paragraph callout:
A paragraph
My note title
A paragraph with a custom title callout
A multi-paragraph callout:
A paragraph
Another paragraph
The last paragraph
My important title
A paragraph
Another paragraph
The last paragraph
An indented callout:
A paragraph
Indented multi-paragraph callouts:
A paragraph
Another paragraph
The last paragraph
Nested callouts:
A paragraph
Nested callouts with Opaque background:
A paragraph
Tables
Markdown tables get responsive styling out-of-the-box:
| Feature | Description |
|---|---|
| Download | Grab the latest binaries |
| Documentation | Read the full API & tutorials |
| Support | Open an issue if you get stuck |
Collapsible ToC
Table of contents
Otherwise for a normal Table of Contents use:
An ordered table of contents:
1. TOC
{:toc}
An unordered table of contents:
- TOC
{:toc}
Lists
Unordered list:
- Item 1
- Item 2
- Item 3
or
- Item 1
- Item 2
- Item 3
Ordered list:
- Item 1
- Item 2
- Item 3
Task list:
- hello, this is a todo item
- hello, this is another todo item
- goodbye, this item is done
Code Blocks
You can do inline code blocks for things like commands and code snippets as you normally would.
Or use syntax highlighted codeblocks, generally: “c" or, "js”
length = 10;
width = 5;
height = 4;
cube([length, width, height]);
Mermaid Diagrams
graph TD;
accTitle: the diamond pattern
accDescr: a graph with four nodes: A points to B and C, while B and C both point to D
A-->B;
A-->C;
B-->D;
C-->D;
Just the Docs OpenSCAD Jekyll Template
This is a bare-minimum template to create a Jekyll site that uses the Just the Docs theme. You can easily set the created site to be published on GitHub Pages – the README file explains how to do that, along with other details.
If Jekyll is installed on your computer, you can also build and preview the created site locally. This lets you test changes before committing them, and avoids waiting for GitHub Pages.1 And you will be able to deploy your local build to a different platform than GitHub Pages.
More specifically, the created site:
- uses a gem-based approach, i.e. uses a
Gemfileand loads thejust-the-docsgem - uses the GitHub Pages / Actions workflow to build and publish the site on GitHub Pages
Other than that, you’re free to customize sites that you create with this template, however you like. You can easily change the versions of just-the-docs and Jekyll it uses, as well as adding further plugins.
Browse our documentation to learn more about how to use this theme.
To get started with creating a site, simply:
- click “use this template” to create a GitHub repository
- go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
If you want to maintain your docs in the docs directory of an existing project repo, see Hosting your docs from an existing project repo in the template README.