This change adds the tutorial links to the sidebar of the documentation. It also removes the tutorial link from within one of the articles (the previous PR) since it is no longer necessary.
Open up Basic-Car-Maintenance .MD files and edit for formatting/layout
Build Documentation by using Product -> Build Documentation
Step 2: Verify Documentation/Hosting:
Commit changes (testing the hosting site adds files that are not to be committed, so this step is important)
modify build-docc.sh script and change hosting-base-path to equal an empty string, so --hosting-base-path ""
run ./build-docc.sh in local repo directory
run /opt/homebrew/bin/python3 -m http.server -d .docs to host documentation on local host
run localhost:8000 in private browser to see documenation
Verify documentation is working
Clean area and push the original commits; otherwise clean area and continue fixing
Notes
I was able to host the tutorials in the sidebar by updating the .MD file formatting. I have provided some of the major highlight areas in a screenshot below.
MD formatting is extremely picky. Wrong formatting causes issues.
The MD formatting tells the documentation to override the default organization of the Xcode build documentation process. It looks like this was needed for the tutorials, and was seen in Runestone's documentation as well.
More information on needed MD file formatting can be found in Apple's documentation, in Apple's Adding structure to your documentation page, subsection Arrange top level symbols using topic groups.
What it Does
How I Tested
Step 1: Fix and Build Documentation:
Step 2: Verify Documentation/Hosting:
build-docc.sh
script and change hosting-base-path to equal an empty string, so--hosting-base-path ""
./build-docc.sh
in local repo directory/opt/homebrew/bin/python3 -m http.server -d .docs
to host documentation on local hostlocalhost:8000
in private browser to see documenationNotes
Screenshot
Tutorials seen in hosted documentation site.
Xcode Build Documentation for comparison
MD file significant formatting notes