source-code-examples: Difference between revisions
Jump to navigation
Jump to search
(guidance for examples) |
(subsections for examples) |
||
| Line 8: | Line 8: | ||
* '''to URL''': the URL of the destination that is being linked to | * '''to URL''': the URL of the destination that is being linked to | ||
Please do your best to put the link into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first) | |||
Sites and or pages that link to their '''top level repository''': | == to repo home == | ||
Sites and or pages that link to their '''top level repository''' or '''repository home page''': | |||
* 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 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/). | ||
* ... | * ... | ||
== to specific repo directory == | |||
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 | ||
* 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 <samp>index.html</samp> source code file of the original 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 <samp>index.html</samp> source code file of the original page | ||
* ... | * ... | ||
== directly to source file == | |||
Sites and or pages that link '''directly to their source code''' (in a repository) | Sites and or pages that link '''directly to their source code''' (in a repository) | ||
* 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 (<samp>.md</samp>) associated with the document. | * 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 (<samp>.md</samp>) associated with the document. | ||
* ... | * ... | ||
Other examples: | == other == | ||
Other examples that do not fit into the above categories / descriptions: | |||
* 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." | * 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." | ||
** https://atproto.com/guides/applications | ** https://atproto.com/guides/applications | ||
Revision as of 22:33, 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.
If you add an example, please explicitly note the:
- from URL: the URL of a visible page on the web that has a link on it to its source code and or repository
- link text: the text (or icon) and perhaps some nearby contextual text that is hyperlinked
- to URL: the URL of the destination that is being linked to
Please do your best to put the link into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first)
to repo home
Sites and or pages that link to their top level repository or repository home page:
- 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/).
- ...
to specific repo directory
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
- ...
directly to source file
Sites and or pages that link directly to their source code (in a repository)
- 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 (.md) associated with the document.
- ...
other
Other examples that do not fit into the above categories / descriptions:
- 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."