https://github.com/denisecase/mandart-docs
MandArt Documentation
https://github.com/denisecase/mandart-docs
docc documentation macos swift swiftui
Last synced: about 2 months ago
JSON representation
MandArt Documentation
- Host: GitHub
- URL: https://github.com/denisecase/mandart-docs
- Owner: denisecase
- Created: 2023-02-05T23:11:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T16:13:42.000Z (about 2 years ago)
- Last Synced: 2025-03-25T10:17:15.805Z (about 1 year ago)
- Topics: docc, documentation, macos, swift, swiftui
- Language: PowerShell
- Homepage: https://denisecase.github.io/MandArt-Docs/documentation/mandart/
- Size: 280 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MandArt-Docs
Documentation for MandArt
- [MandArt](https://github.com/denisecase/MandArt)
- [Documentation](https://denisecase.github.io/MandArt-Docs/documentation/mandart/)
-----
## 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.
1. When viewing the generated docs, right-click on MandArt and click "Export".
1. The default name is MandArt.doccarchive.
## Export for Static Hosting
Run in terminal in MandArt root folder
```terminal
$(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.
```shell
git add .
git commit -m "your message"
git push origin main
```
-----
## Links
Documentation hosted at:
- [docs](https://denisecase.github.io/MandArt-Docs/documentation/mandart/)
- [repo](https://github.com/denisecase/MandArt-Docs)
## Fix Apple Docc Errors
- add theme-settings.json in same folder as favicon.ico