denisecase / MandArt-Docs

MandArt Documentation

MandArt-Docs

Documentation for MandArt

• MandArt
• Documentation

---

Configre Pages in GitHub (one-time)

In this docs repo in GitHub, use settings to deploy with Pages. Hint: Settings / Pages / main / docs.

On Update, Delete This Docs folder

In this repo folder on your machine, delete the docs folder.

Generate New MandArt Documentation

Create new documentatation:

1. In the MandArt project in XCode, click Product / Build Documentation.

2. When viewing the generated docs, right-click on MandArt and click "Export".

3. The default name is MandArt.doccarchive.

Export for Static Hosting

Run in terminal in MandArt root folder

$(xcrun --find docc) process-archive transform-for-static-hosting ./DerivedData/Build/Products/Debug/MandArt.doccarchive --output-path ./docs --hosting-base-path MandArt-Docs/

Move the Docs Folder

Move Mandart/docs folder to MandArt-Docs/docs.

Open in VS Code to format

If desired, open this repo in VS Code and format the .html files.

Push to GitHub

Git add, commit, and push new GitHub MandArt-Docs.

git add .
git commit -m "your message"
git push origin main

---

Links

Documentation hosted at:

• docs
• repo

Fix Apple Docc Errors

• add theme-settings.json in same folder as favicon.ico