source-code-examples - Revision history

JamesGallagher: remove unused colons

2025-05-26T09:37:15Z

remove unused colons

← Older revision		Revision as of 09:37, 26 May 2025
Line 14:		Line 14:
	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)
	* Hugging Face		* Hugging Face
	** <b>from URL:</b>: https://huggingface.co/docs/transformers/en/model_doc/blip-2		** <b>from URL:</b> https://huggingface.co/docs/transformers/en/model_doc/blip-2
	** <b>anchor text</b>: "< > 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.		** <b>anchor text:</b> "< > 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.
	** <b>to URL:</b>: https://github.com/huggingface/transformers/blob/main/docs/source/en/model_doc/blip-2.md		** <b>to URL:</b> https://github.com/huggingface/transformers/blob/main/docs/source/en/model_doc/blip-2.md
	* ...		* ...

JamesGallagher: /* directly to source file */

2025-05-26T09:36:54Z

directly to source file

← Older revision		Revision as of 09:36, 26 May 2025
Line 13:		Line 13:
	== directly to source file ==		== 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.		* Hugging Face
			** <b>from URL:</b>: https://huggingface.co/docs/transformers/en/model_doc/blip-2
			** <b>anchor text</b>: "< > 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.
			** <b>to URL:</b>: https://github.com/huggingface/transformers/blob/main/docs/source/en/model_doc/blip-2.md
	* ...		* ...

Tantek: re-order example sections more specific / direct to less

2025-05-25T22:34:52Z

re-order example sections more specific / direct to less

← Older revision		Revision as of 22:34, 25 May 2025
Line 9:		Line 9:
	* '''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 example into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first)		Please do your best to put the example into ONE of the following subsections (only one should make sense, if it "fits" in multiple, only put it in the first one that fits.)

	== to ~~repo home~~ ==		== directly to source file ==
	Sites and or pages that link ~~to their~~ '''~~top level repository''' or~~ '''repository ~~home page''':~~		Sites and or pages that link '''directly to their source code''' (in a repository)
	* https://~~docusaurus~~.io/docs/~~docs~~-~~introduction links to the project GitHub in the footer (link anchor text is~~ "GitHub")		* 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.
	* 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~~/).
	* ...		* ...

Line 22:		Line 21:
	* ...		* ...

	== ~~directly~~ to ~~source file~~ ==		== to repo home ==
	Sites and or pages that link '''~~directly to their source code~~''' ~~(in a~~ repository)		Sites and or pages that link to their '''top level repository''' or '''repository home 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~~ (~~<samp>~~.~~md<~~/~~samp>~~) ~~associated with the document~~.		* 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/).
	* ...		* ...

Tantek: example

2025-05-25T22:34:13Z

example

← Older revision		Revision as of 22:34, 25 May 2025
Line 9:		Line 9:
	* '''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)		Please do your best to put the example 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 ==		== to repo home ==

Tantek: guide

2025-05-25T22:33:52Z

guide

← Older revision		Revision as of 22:33, 25 May 2025
Line 3:		Line 3:
	Examples of pages that link to their [[source-code]] and or a repository for such code.		Examples of pages that link to their [[source-code]] and or a repository for such code.

			== guide to adding examples ==
	If you add an example, please explicitly note the:		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		* '''from URL''': the URL of a visible page on the web that has a link on it to its source code and or repository

Tantek: float toc

2025-05-25T22:33:37Z

float toc

← Older revision		Revision as of 22:33, 25 May 2025
Line 1:		Line 1:
	{{stub}}		{{stub}}
			<span style="float:right">__TOC__</span>
	Examples of pages that link to their [[source-code]] and or a repository for such code.		Examples of pages that link to their [[source-code]] and or a repository for such code.

Tantek: subsections for examples

2025-05-25T22:33:09Z

subsections for examples

← Older revision		Revision as of 22:33, 25 May 2025
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

Tantek: guidance for examples

2025-05-25T22:31:29Z

guidance for examples

← Older revision		Revision as of 22:31, 25 May 2025
Line 2:		Line 2:

	Examples of pages that link to their [[source-code]] and or a repository for such code.		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

Tantek: note .md

2025-05-25T22:23:25Z

note .md

← Older revision		Revision as of 22:23, 25 May 2025
Line 14:		Line 14:

	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 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.
	* ...		* ...

Tantek: move huggingface example to directly to source code list

2025-05-25T22:23:02Z

move huggingface example to directly to source code list

← Older revision		Revision as of 22:23, 25 May 2025
Line 11:		Line 11:
	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
	* 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)		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 associated with the document.
	* ...		* ...