holochain / holochain/docs-pages
Docusaurus migration: custom-styled blocks
- Dominant language
- Nunjucks
- Stars
- 98
- Forks
- 32
- Avg merge
- 9h 49m
- Merged PRs (30d)
- 2
Description
On the 11ty-based site, we have some custom code blocks:
* admonitions (only one type, `info` -- it'd be nicer if we had the usual full palette of admonitions such as `warn` and `tip`)
* `intro`
* `orientation`
* `storystep`
* `h-author` (not sure what this is for; check to see whether it's still needed)
* `topic-list`
* `output-block` (made to suppress the copy button on code blocks)
Replicate their functionality and, if necessary, change Markdown documents to match whatever syntax they now use.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the existing 11ty custom block definitions and searching the Markdown documents for admonitions, intro, orientation, storystep, h-author, topic-list, and output-block usage. Map each block to the Docusaurus syntax, verify whether h-author is still needed, and confirm that the affected documentation renders with equivalent behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100