[MCL-5] Set up Antora documentation pages Created: 07/Dec/23  Updated: 03/Jan/24  Resolved: 03/Jan/24

Status: Closed
Project: Magnolia Component Library
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Raymond Tran Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty

 Description   

Set up Antora documentation pages so we can write up man pages for the components and templates.



 Comments   
Comment by Raymond Tran [ 03/Jan/24 ]

To get Antora docs to render on local, use these instructions. # Clone the btk repo to ~/development/btk . Change to mcl branch

  1. Clone slim-antora-build repo: https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/slim-antora-build/browse to ~/development/slim-antora-build
  2. Run npm i -g http-server
  3. Run npm i -g antora
  4. In slim-antora-build directory open playbook.yml  and add the btk directory as a content source. README.md shows you how to do this
  5. In slim-antora-build directory run antora playbook.yml
  6. Run http-server local-build to view the generated documentation
Generated at Mon Feb 12 04:48:36 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.