/docs-starter

Quickly create a really good documentation website by using this repo and a template.

Primary LanguageHTML

IPFS Docs v2.0

This repository contains example layouts for the proposed v2.0 of the ipfs-docs. Unlike the current ipfs-docs site, this site is built on @johhnymatthew's WIP docs-starter, a handy Hugo-based platform to quicky create technical documentation.

Overview

This repo currently contains the following branches:

  • proposal-1: this is the branch containing the layout for proposal 1.
  • proposal-3: this is the branch containing the layout for proposal 3.
  • test: this is the branch that is used for testsing purposes, and is liable to change at any time
  • main: this branch matches the main branch of docs-starter

Viewing a Proposal

  1. Clone or fork this repo
  2. Fetch the branch you want to view (proposal-1 or proposal-3)
  3. In the branch, run npm run start
  4. Navigate to http://localhost:1313/