This is how you can create a new document for inclusion into piCorePlayer Documentation.
There are various options with the intention of making it easy to submit content to the piCorePlayer Documentation. You can start by submitting a “plain text file” right up to using Markdown with shortcodes and using Hugo to publish to a local server for checking.
Plain textThis is the simplest way to do it.
A user:
This page contains examples of Markdown syntax. HeadingsThe following HTML <h1>—<h6> elements represent six levels of section headings.
Example:# This is an H1 - Do not use - Defined by title/description front matter ## This is an H2 - added to table of contents ### This is an H3 - added to table of contents #### This is an H4 ##### This is an H5 - label ###### This is an H6 Result:This is an H2 - added to table of contentsThis is an H3 - added to table of contentsThis is an H4This is an H5 - labelThis is an H6ParagraphsParagraphs are separated by empty lines.
Shortcodes are used to add a little more functionality to Markdown. Shortcodes are located in the layouts sub-directory. Shortcodes available Shortcode Description card.html Used for warning and danger message childpages.html Used to generate links to child pages code.html Used to display code with a copy button lead.html Used for a lead in paragraph table.html Used to format tables Card shortcodeDraw the reader’s attention by separating information from the rest of the page.
Front matter - YAML formatted. Example front matter--- title: Front matter description: Front matter - YAML meta data date: 2020-09-24 author: pCP Team weight: 6 pcpver: "6.1.0" toc: false draft: false hidden: false categories: - Publishing tags: - Front matter --- VariablesTitleThe title variable:
is used in the left hand navigation menu. is used in the Previous/Next links at the bottom of the page. should be relatively brief. It is desireable for the the title to be a single line in the navigation menu.
Instructions for setting up Hugo 0.124.1 for Windows 10. Similar process for Linux. Hugo setup - Windows 10See Installing Hugo.
StepsStep 1 - Create directory structureC:. └── Hugo ├── bin └── pCP-docs $ cd \
$ mkdir Hugo
$ cd Hugo
$ mkdir bin
$ mkdir pCP-docs
Step 2 - Add c:\Hugo\bin to $PATHEdit the system environment variables.
Click [Environment Variables].
Step 3 - Download HugoDownload the appropriate Hugo executable—see Download Hugo.
The piCorePlayer Documentation source is mostly written in Markdown. So sometimes it is necessary to convert existing HTML pages into Markdown using an online service for inclusion in the documentation. StepsStep 1 - Copy HTML source In the web page, select View source (ctrl+u in Edge) Copy the HTML code by: Clicking on the HTML window to set focus. Highlight all source (ctrl+a). Copy highlighted source (ctrl+c). Step 2 - Convert HTML to Markdown Open Turndown—click Turndown - HTML to Markdown.
These instructions are intended for pCP Team. Step 1 - Start Hugo$ cd c:\Hugo\pCP-docs
$ hugo server
Optional:
Publish draft documents (draft: true)
$ hugo server -D
Publish future dated documents
$ hugo server -F
Force a republish of everything
$ hugo server --disableFastRender
Step 2 - Edit/add files under c:\Hugo\pCP-docs\content
C:. ├───bin └───pCP-docs ├───archetypes ├───content │ ├───admin │ ├───components │ ├───downloads │ ├───faq │ ├───getting-started │ ├───how-to │ ├───information │ ├───projects │ └───releases ├───data ├───layouts ├───resources ├───static └───themes Step 3 - View changesType http://localhost:1313/ into browser.
The Software and Information is provided "as is" without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement.
Raspberry Pi is a trademark of the Raspberry Pi Foundation.