-
Notifications
You must be signed in to change notification settings - Fork 134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Port documentation from html to markdown #564
Merged
Merged
Commits on Jul 30, 2024
-
Port docs to md rendered to html by Github Pages.
Use https://just-the-docs.com/ template. And setup Home page. Need to use custom deployment workflow to be able to use docs/ as source, which is slightly inconvenient compared to other themes but might allow more customisation later. The benefit of deploying docs is that the main/landing page will display automatically when clicking on docs in Github. Then navigation is straightforward.
Configuration menu - View commit details
-
Copy full SHA for 7aed439 - Browse repository at this point
Copy the full SHA 7aed439View commit details -
Move sections to dedicated folders and convert landing page
Sections' landing pages are now rendered in github (section/README.md) and on website (section/index.html). Providing the pages permalink will make links to other pages work in both Github and website. Note the / matters at the end of the permalinks it allows to maintain directory structure (in presence of parent/child sections) or not, Fix tables of content. Links to images and test files, and old html content will break, it is fixed in following commits.
Configuration menu - View commit details
-
Copy full SHA for 9cf38ab - Browse repository at this point
Copy the full SHA 9cf38abView commit details -
Cleanup: Move images to img/ and sources to src/
This breaks all the links, therefore needs to be fixed in following commits.
Configuration menu - View commit details
-
Copy full SHA for b8b76fc - Browse repository at this point
Copy the full SHA b8b76fcView commit details -
Need to use relative link to be able to render in both github and website, absolute link can only work in both cases if root is deployed (instead of docs/). Convert some html to markdown for picture, downside is resizing impossible in md.
Configuration menu - View commit details
-
Copy full SHA for ef9fbec - Browse repository at this point
Copy the full SHA ef9fbecView commit details -
Need to use relative link to be able to render in both github and website. Other option would be to have a dedicated src/ in each section.
Configuration menu - View commit details
-
Copy full SHA for c416ca6 - Browse repository at this point
Copy the full SHA c416ca6View commit details -
Configuration menu - View commit details
-
Copy full SHA for b9759a3 - Browse repository at this point
Copy the full SHA b9759a3View commit details -
More than just changing the path. For github rendering we need to - not refer to html files - use relative path since absolute path changes between website and github - permalinks ensure a similar file structure A solution to these issues would be to deploy the root of sleef, this would have the benefit of not needing a workflow and a Gemfile.
Configuration menu - View commit details
-
Copy full SHA for 4d8c311 - Browse repository at this point
Copy the full SHA 4d8c311View commit details -
Improve/Fix tables. Simplify logo (rename and get rid of old ones).
Configuration menu - View commit details
-
Copy full SHA for c0c1b57 - Browse repository at this point
Copy the full SHA c0c1b57View commit details -
Use ``` for code and command sections. Remove <p></p> when no alignement is needed. Reformat links using markdown Following stuff is left for later - Not sure what to do about titles, github does not allow short labels, so we would need to change the links to long titles. - Cannot autogen TOC because headers need to be in html to allow for custom labels
Configuration menu - View commit details
-
Copy full SHA for 23d761c - Browse repository at this point
Copy the full SHA 23d761cView commit details -
Configuration menu - View commit details
-
Copy full SHA for d009666 - Browse repository at this point
Copy the full SHA d009666View commit details -
Configuration menu - View commit details
-
Copy full SHA for 06a92b4 - Browse repository at this point
Copy the full SHA 06a92b4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5e8df69 - Browse repository at this point
Copy the full SHA 5e8df69View commit details -
Configuration menu - View commit details
-
Copy full SHA for 964a0e0 - Browse repository at this point
Copy the full SHA 964a0e0View commit details
Commits on Aug 9, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 5ccfcc3 - Browse repository at this point
Copy the full SHA 5ccfcc3View commit details -
Configuration menu - View commit details
-
Copy full SHA for c05de91 - Browse repository at this point
Copy the full SHA c05de91View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1bc1ff7 - Browse repository at this point
Copy the full SHA 1bc1ff7View commit details
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.