Fork and add a copy of Tom Johnson's Jekyll Documentation Theme
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- css, jekyll
- Domain
- documentation
Research direction
Start by reviewing the linked Tom Johnson Documentation theme and the liquidoc-cmf repository. Resolve whether this should be a maintained fork or a converter, then define how it will support AsciiDoc and LiquiDoc and whether it will remain an optional branch. Done means a working theme approach is selected and integrated for users.
Written by the indexing model from the issue text.
Description
It's time to make a version of the Documentation theme that works well with AsciiDoc and LiquiDoc.
One idea is to make a converter, which would rename directories, insert some files, but otherwise fall back on the prime version. But it's more likely the best idea to maintain a proper fork, as some modifications we would make sense to contribute back, even if the overhaul is pretty thorough. We may keep it as an optional branch of this repo, so users can choose a bare-bones LDCMF and code their own theme, or they can stay in sync with the latest boilerplate edition of this theme, and maybe later others as well.
- Dominant language
- CSS
- Stars
- 9
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DocOps/liquidoc-cmf
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
DocOps/liquidoc-cmf#12 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
DocOps/liquidoc-cmf#11 ·
-
enhancement Summer2019
Difficulty 5/5 Over a week Newbie friendliness 20/100
DocOps/liquidoc-cmf#10 ·
-
enhancement Summer2019
Difficulty 3/5 1-2 days Newbie friendliness 35/100
DocOps/liquidoc-cmf#9 · 1 reaction ·
-
enhancement Summer2019
Difficulty 5/5 Over a week Newbie friendliness 25/100
DocOps/liquidoc-cmf#7 ·
All issues in DocOps/liquidoc-cmf
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
Maintainers usually reply within 1 day
-
[ordering-review] workshop order graph: 1 confirmed ordering problem, 3 cycles are false positivesOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
githubnext/gh-aw-workshop#4943 · 1 comment ·
Maintainers usually reply within 1 day
-
Awaiting Triage
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100