Markdown
Last updated
Was this helpful?
Last updated
Was this helpful?
Markdown is a universal doc format that is easy to write and easy to add to a version control system.
Open - Anyone can submit content, fix typos & update anything via pull requests
Version control - Roll back & see the history of any given post
No CMS lock in - We can easily port to any static site generator
It's just simple - No user accounts to manage, no CMS software to upgrade, no plugins to install.
The basics of markdown can be found & . Super easy!
left alignmentThis is the code you need to align images to the left:
right alignmentThis is the code you need to align images to the right:
center alignment examplecollapse SectionsCollapsing large blocks of text can make your markdown much easier to digest
Collapsing large blocks of Markdown text
additional linksI hate them so. Don't use badges.
YAML front-matter is your friend. You can keep metadata in markdown files
Useful for rendering markdown in HTML/React
Show DEMO
Show DEMO
Serverless.com is comprised of 3 separate repositories
https://github.com/serverless/blog
https://github.com/serverless/site
Why multiple repos?
We wanted documentation about the framework to live in the serverless github repo for easy access
We wanted our blog content to be easily portable to any static site generator separate from the implementation (site)
prebuild npm script pulls the content together & processes them for site build
A single repo is easier to manage but harder for people to find/edit/PR content.
Site structure
Serverless build process
Github optimizations
consider linking everything to site
• • • • • • •
For whatever the graphql syntax will nicely highlight file trees like below:
Show automatic doc generation. |
- Post scheduler for static sites
& - Good Editors
- Flow charts for days
- Make gifs
Stuck on WordPress? Try
https://github.com/serverless/serverless | Shoutout to
use markdown magic =) to etc
- Documentation generator for GitHub projects
- Markdown alternative