LispCookbook / LispCookbook/cl-cookbook

Website overhaul?

Open
#306 33 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.1k
Forks
158
Avg merge
6d 3h
Merged PRs (30d)
2

Description

Continuing the nascent discussion in #279:

we'd enjoy a faster website generator (for local work), and a better looking theme.

Hugo themes for documentation: https://themes.gohugo.io/tags/documentation/

- https://docs.vantage-design.com/ace/getting-started/usage/ (nice one, simple to install and build, npm not required)

Use Coleslaw? https://github.com/coleslaw-org/coleslaw

Material for Mkdocs: https://squidfunk.github.io/mkdocs-material/ (python)
- pretty complete
cons: (update 2021)
- need a redirection trick too. Its URL doesn't end in ".html", for example it's "getting-started/", not "getting-started.html".

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in #279 and reviewing the linked Hugo, Ace, Coleslaw, and Material for MkDocs references. Compare the requested faster local generation, theme, and URL/redirect behavior; done is not defined in the issue and needs a chosen approach and concrete scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo, python
Domain
build-system, documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.