Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

[Docs tooling] Set up Hugo #24

Open
kickoke opened this issue Aug 27, 2022 · 2 comments
Open

[Docs tooling] Set up Hugo #24

kickoke opened this issue Aug 27, 2022 · 2 comments
Assignees
Labels

Comments

@kickoke
Copy link
Collaborator

kickoke commented Aug 27, 2022

To simplify our docs setup, I want to set up a Hugo environment along with the tufte css template.
Pros:

  • Tufte allows us to annotate our content
  • Hugo is supported by the tech team
  • Learning curve is less steep than with Docusaurus

CC: @bwklein

@kickoke kickoke added the tools label Aug 27, 2022
@kickoke kickoke self-assigned this Aug 27, 2022
@kickoke
Copy link
Collaborator Author

kickoke commented Aug 28, 2022

Preview: https://24-hugo--docs-chronologue.netlify.app/

Still to do:

Content

  • Clean up frontmatter to match with what Hugo supports
  • Create navigation for the API docs and the Chronologue user guide
  • Flesh out homepage

Adjust CSS:

  • Rewrite CSS so that margin notes don't break.
  • Add responsive design

Documentation

  • Write down how the repository works and how to add/maintain content.

Publication

  • Merge into docs branch
  • Resolve merge conflicts

See Tufte features: https://raw.githubusercontent.com/shawnohare/hugo-tufte/master/exampleSite/content/post/tufte-features.md

@kickoke
Copy link
Collaborator Author

kickoke commented Sep 19, 2022

Disregard the above comment.

I am working on a simple theme for our docs, since the fixes began to become endless...

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant