- Notifications
You must be signed in to change notification settings - Fork4
netdata/blog
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This website is built usingDocusaurus 2, a modern static website generator.
- Create a branch for your post.
- In your branch create a file like
blog/2022-01-01-my-blog-slug.mdor (better since can add images in folder alongside the post)blog/2022-01-01-my-blog-slug/index.md(soblog/<yyyy-mm-dd>-<url-slug-you-want>.mdorblog/<yyyy-mm-dd>-<url-slug-you-want>/index.md). - Addfrontmater metadata at top of post (use an existing post as an example or starting point). Add yourself to
/blog/authors.ymlif needed. - Create your post in markdown, or .mdxlike this one if need to embed a YouTube video or do anything else a bit more fancy.
- Create a PR from your branch into
master(this will trigger a deployment preview).
- Use
for images. - For
tags, pick fromexisting tags if any seem relevant. Feel free to make new ones if needed. - Use H2 and H3 section headings like this:
## This is a H2and'### This is a H3. They will appear as useful section headings on the right hand side when a user is in the blog. - Anything between start of post and
<!--truncate-->will appear as a preview on blog landing page. - Usecode blocks and tell the code block what language to use so it looks as pretty as possible.
- If you have images you can upload them to your PR and just use the github url for them. Better would be to make a folder for your post and include images locally. Seethis post as an example.
- If you want to work locally you can create a development preview of the site with
npm installand thennpm run start. If builds successfully a local version of the blog will be at:http://localhost:3000/ - Usehttps://socialsharepreview.com/ to check the url before sharing on social media sites. This is to make sure it appears nice when shared on social.
$ yarnor
$ npm install$ yarn startor
$ npm run startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn buildor
$ npm run buildThis command generates static content into thebuild directory and can be served using any static contents hosting service.
Deployment is automated by Netlify. All PR's tomaster will trigger a deployment preview in Netlify which will be added to the PR.
About
Netdata's Blog!
Topics
Resources
License
Code of conduct
Contributing
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.