Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.75 KB

README.md

File metadata and controls

54 lines (42 loc) · 2.75 KB

Documentation Slack Chat Build Status Latest Stable Version License

Documentation

The repository of docs.lucidarch.dev.

Run Docs Locally

  • Clone this repository
  • Clone theme: git submodule init && git submodule update
  • Run server container with docker-compose up -d and changes will take effect on save
  • Visit http://localhost:1313 to see it

Contribute

The docs are built using Hugo with a customised version of docport theme.

  • Fork this repository
  • Create a branch for your contribution git checkout -b fix/issue-32
  • Run build container using docker-compose up -d and from here on changes will take effect on save
  • Generate a new section/_index.md file using docker-compose exec hugo hugo new {section}/_index.md (yes two hugos), or edit an existing section
  • Commit your changes with a meaningful short message
  • Push the code to your repository git push origin fix/issue-32
  • Open a pull request in this repository to the main branch

Structure

  • Hugo configuration is in config.toml as indicated in the docs

  • Every section in the sidebar is a directory with its name in snake-case under content, and an _index.md file at its root

  • The head of _index.md is the definition of the section

    ---
    
    title: "CLI Reference"
    date: 2020-10-28T17:04:19Z
    draft: false
    weight: 15
    hide: ["header"]
    head: "<hr />"
    
    
    ---
    
    • date will be taken care of by the engine when generating a new file with hugo new
    • weight organizes section in their order
    • hide things to hide when the section is visited. Options are: header and toc
    • head only present for sections that need something in their head, absent in the others that don't.