source-code-examples: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(add mkdocs-material example) |
||
| Line 5: | Line 5: | ||
Sites and or pages that link to their top level repository: | Sites and or pages that link to their top level repository: | ||
* https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub") | * https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub") | ||
* Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/). | |||
Sites and or pages that link to the specific directory that contains the source (code) for the page | Sites and or pages that link to the specific directory that contains the source (code) for the page | ||
Revision as of 22:18, 25 May 2025
This article is a stub. You can help the microformats.org wiki by expanding it.
Examples of pages that link to their source-code and or a repository for such code.
Sites and or pages that link to their top level repository:
- https://docusaurus.io/docs/docs-introduction links to the project GitHub in the footer (link anchor text is "GitHub")
- Sites built with the mkdocs-material theme (a popular Python documentation theme) have a feature to add a repository link in the top left corner of the site (example on https://squidfunk.github.io/mkdocs-material/plugins/).
Sites and or pages that link to the specific directory that contains the source (code) for the page
- https://w3c.github.io/png/Implementation_Report_3e/ has the text "This implementation report is on GitHub. " where GitHub links to https://github.com/w3c/png/tree/main/Implementation_Report_3e which is the directory containing the index.html source code file of the original page
- https://huggingface.co/docs/transformers/en/model_doc/blip-2 has an "< > Update on GitHub" link at the very bottom of their docs pages which links to the markdown text file associated with the document.
- ...
Sites and or pages that link directly to their source code (in a repository)
- ...
Other examples:
- A site that links to a repository homepage that is not the repo for the site the page is on, with the anchor text "Find the source code for the example application on GitHub."