paint-brush
Setting Up Docs For An Open Source Project Doesn't Have To Be Hardby@0x0ece

Setting Up Docs For An Open Source Project Doesn't Have To Be Hard

by Emanuele Cesena2mMay 19th, 2021
Read on Terminal Reader
Read this story w/o Javascript
tldt arrow

Too Long; Didn't Read

A practical guide to set up Jekyll + Github Pages for docs. This article describes how we set up docs for our open source project Saasform. It's easy to structure docs as part of the source code, so they're browsable and easy to maintain. Use a remote theme, like pmarsceill/just-the-doc, to publish the docs. Publish via Github Pages and create the docs files. Use the URL of each individual page to specify URLs of each page.

Company Mentioned

Mention Thumbnail
featured image - Setting Up Docs For An Open Source Project Doesn't Have To Be Hard
Emanuele Cesena HackerNoon profile picture
Emanuele Cesena

Emanuele Cesena

@0x0ece

Making the open source @SoloKeysSec and the @Everdragons2 NFT. Former security at Pinterest, now at Jump.

About @0x0ece
LEARN MORE ABOUT @0X0ECE'S
EXPERTISE AND PLACE ON THE INTERNET.
L O A D I N G
. . . comments & more!

About Author

Emanuele Cesena HackerNoon profile picture
Emanuele Cesena@0x0ece
Making the open source @SoloKeysSec and the @Everdragons2 NFT. Former security at Pinterest, now at Jump.

TOPICS

THIS ARTICLE WAS FEATURED IN...

Permanent on Arweave
Read on Terminal Reader
Read this story in a terminal
 Terminal
Read this story w/o Javascript
Read this story w/o Javascript
 Lite