add editing guide to site

This commit is contained in:
EilidhRoss1 2022-09-15 17:11:34 +01:00
parent 43c1306003
commit 885449e12f
1 changed files with 0 additions and 4 deletions

View File

@ -18,7 +18,6 @@ You will find the wiki content mostly in the folders claims and concept
The website is written in Markdown. A tool called content layer converts the Markdown files into HTML (the standard computer language for displaying and formatting web pages) so that they are displayed as pages on the site. This is the case for all pages on the website except for the homepage which is written directly in HTML. The website is written in Markdown. A tool called content layer converts the Markdown files into HTML (the standard computer language for displaying and formatting web pages) so that they are displayed as pages on the site. This is the case for all pages on the website except for the homepage which is written directly in HTML.
#### Markdown #### Markdown
Markdown is a markup language (computer language for displaying and formatting web pages), which is designed to be easy to write and easy to read. Its widely deployed on the web, for example by DataHub, GitHub, Stackoverflow and many other sites. Markdown is a markup language (computer language for displaying and formatting web pages), which is designed to be easy to write and easy to read. Its widely deployed on the web, for example by DataHub, GitHub, Stackoverflow and many other sites.
@ -27,12 +26,10 @@ In Markdown, you control the display of the document. For instance, you can form
Head over to our [Markdown Guide](https://playbook.datopian.com/markdown/#why-markdown) to learn more about Markdown and how to use it. Head over to our [Markdown Guide](https://playbook.datopian.com/markdown/#why-markdown) to learn more about Markdown and how to use it.
#### Front Matter #### Front Matter
In the world of computer programming, front matter is metadata (data about data) at the top of a file. Front matter does two things: a) it displays key info about a page (such as its title and description) in a structured way which helps with a consistent layout throughout the site and b) is used as metadata for SEO (search engine optimization) purposes, helping our content to reach interested readers. In the world of computer programming, front matter is metadata (data about data) at the top of a file. Front matter does two things: a) it displays key info about a page (such as its title and description) in a structured way which helps with a consistent layout throughout the site and b) is used as metadata for SEO (search engine optimization) purposes, helping our content to reach interested readers.
##### Using front matter ##### Using front matter
Front matter should always be at the very top of the Markdown file, marked out by three dashes (---) above and below. Front matter should always be at the very top of the Markdown file, marked out by three dashes (---) above and below.
@ -109,7 +106,6 @@ In this stage, you clone your forked repository, i.e. you copy your forked
* Type into Terminal the command “git clone” and then paste the repo URL you copied. E.g. “git clone https://github.com/life-itself/web3.git”. Press enter. (1:13-1:48) * Type into Terminal the command “git clone” and then paste the repo URL you copied. E.g. “git clone https://github.com/life-itself/web3.git”. Press enter. (1:13-1:48)
* N.B. When you try this, you may be prompted to install command line developer tools to be able to run git commands, e.g. XCode for Mac. If this is the case, follow the instructions for installation. * N.B. When you try this, you may be prompted to install command line developer tools to be able to run git commands, e.g. XCode for Mac. If this is the case, follow the instructions for installation.
##### Stage 3: Branch ##### Stage 3: Branch
In this stage, you create a new branch, or temporary version, of the repository on which to make edits. These edits will later be merged with the main repository branch. In this stage, you create a new branch, or temporary version, of the repository on which to make edits. These edits will later be merged with the main repository branch.