From 5bf99f3c0650eafb43a29f8d740618287f3b68bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Quiroz?= Date: Wed, 4 Jan 2023 18:33:43 -0300 Subject: [PATCH] docs: add frontmatter metadata example --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d346908392..8bfc986ac5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is the repository for the `go-ethereum` website. All the website code is held here in the `website` branch. If you are looking for `go-ethereum` source code you need to switch to the `master` branch. -The purpose of the go-ethereum website is to provide the necessary documentation and supporting information to help users to get up to speed with using go-ethereum (aka "Geth"). The website is maintained by a team of developers but community contributions are also very welcome. +The purpose of the go-ethereum website is to provide the necessary documentation and supporting information to help users to get up to speed with using go-ethereum (aka "Geth"). The website is maintained by a team of developers but community contributions are also very welcome. ## Contributing @@ -29,7 +29,7 @@ The website code is organized with a top-level `docs` folder that contains all t Documentation pages are located in the `/docs` folder in the root directory of the project. The docs pages are all markdown files. When you want to add a new page, add the new file in the appropriate folder in the `/docs` page. `index.md` files will be the default page for a directory, and `{pagename}.md` will define subpages for a directory. -After adding a page, you will also need to list it in `/src/data/documentation-links.yaml`. This file defines the documentation structure which you will see on the left sidebar in the documentation pages. +After adding a page, you will also need to list it in `/src/data/documentation-links.yaml`. **This file defines the documentation structure which you will see on the left sidebar in the documentation pages**. Take into account that if you update the `/docs` structure or remove a doc, you should also update this file to avoid navigation issues. #### Adding notes to a doc @@ -41,8 +41,7 @@ Notes in documentation pages are highlighted boxes (color depend on the current Screen Shot 2023-01-04 at 18 22 06 -> Example Note from [Account Management with Clef -](https://geth.ethereum.org/docs/fundamentals/account-management) doc +> Example Note from [Account Management with Clef](https://geth.ethereum.org/docs/fundamentals/account-management) doc. #### Images @@ -52,6 +51,19 @@ Images should be saved to `public/images/docs` and included in the markdown as f ![alt-text](/images/docs/image-title.png) ``` +#### Metadata + +`title` and `description` are **required** metadata props for a post: `title` will generate the main heading on the doc page and `description` is used for SEO purposes, to serve as a concise and appropiate description of the content. + +``` +--- +title: Go API +description: Introduction to the Go packages that allow Geth to be used in Go native applications. +--- +``` + +> Example of the metadata for a sample post. + ### Building locally To check a new page it is helpful to build the site locally and see how it behaves in the browser. First, run the development server: