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 text #This is the simplest way to do it. A user:
This page contains examples of Markdown syntax. For more detailed descriptions of Markdown syntax—see: CommonMark help CommonMark specification . Learn Markdown Markdown Guide Headings #The 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 contents #This is an H3 - added to table of contents #This is an H4 #This is an H5 - labelThis is an H6Paragraphs #Paragraphs are separated by empty lines.
Shortcodes are used to add a little more functionality to Markdown. Shortcodes are located in the theme layouts directory. Card shortcode #Draw the reader’s attention by separating information from the rest of the page. Convey meaning to this information by using colors implying success, info, warning, or danger and an appropriate icon. Danger Be sure to read me, I might have important information for you. Usage #Simply place the following shortcode in the document.
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 --- Variables #Title #The 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.
Instructions for setting up Hugo for Windows 10. Similar process for Linux. Hugo setup - Windows 10 #See Installing Hugo . Step 1 - Create directory structure # C:. └── Hugo ├── bin └── pCP-docs $ cd \ $ mkdir Hugo $ cd Hugo $ mkdir bin $ mkdir pCP-docs Step 2 - Add c:\Hugo\bin to $PATH #Edit the system environment variables. Click [Environment Variables]. Step 3 - Download Hugo #Download the appropriate Hugo executable—see Download Hugo ie.
Step 1In web page, View source (Ctrl+U in Edge) Copy the HTML code by: clicking on HTML window to set focus type ctrl+a type ctrl+c Step 2Open Turndown—click Turndown - HTML to Markdown Set Heading style to atx Set Bullet to - Set Code block style to fenced Paste in left HTML window ctrl+v Copy result from right MARKDOWN window ctrl+a, ctrl+c Step 3Paste into text editor ctrl+c
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 changes #Type http://localhost:1313/ into browser.
Instructions for pCP Team Only. Adding a Download #Step 1. - Start Hugo #$ cd c:\Hugo\pCP-docs $ hugo server Step 2. - Edit pCP-docs\content\downloads\_index.md #Example of existing _index.md (Front matter - YAML formatting)--- title: Downloads description: date: 2020-08-08 <-- edit author: pCP Team weight: 6 pcpver: "6.1.0" <-- edit toc: false draft: false download: - pcpversion: "6.1.0" -- pcpdate: 2020-06-06 | cut and paste 4 lines url: false | indentation 2 spaces (tabs not allowed) realtime: true -- - pcpversion: "6.