From 6cdc31d2a7f808caff3298800fd91d0d6642bbee Mon Sep 17 00:00:00 2001 From: Jules Parker <19994093+jules-p@users.noreply.github.com> Date: Thu, 4 Aug 2022 11:11:09 +0200 Subject: [PATCH 1/5] clarifies availability of math, mermaid, etc --- .../documenting-your-project-with-wikis/about-wikis.md | 4 +++- .../editing-wiki-content.md | 5 +++++ .../working-with-advanced-formatting/creating-diagrams.md | 2 +- .../writing-mathematical-expressions.md | 4 ++++ data/reusables/getting-started/available-throughout.md | 1 + data/reusables/getting-started/math-and-diagrams.md | 1 + 6 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 data/reusables/getting-started/available-throughout.md create mode 100644 data/reusables/getting-started/math-and-diagrams.md diff --git a/content/communities/documenting-your-project-with-wikis/about-wikis.md b/content/communities/documenting-your-project-with-wikis/about-wikis.md index c9ab964dbd..d270e7ba51 100644 --- a/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -17,7 +17,9 @@ topics: Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)." -With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. +With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. + +{% data reusables.getting-started.math-and-diagrams %} {% ifversion fpt or ghes or ghec %}If you create a wiki in a public repository, the wiki is available to {% ifversion ghes %}anyone with access to {% data variables.product.product_location %}{% else %}the public{% endif %}. {% endif %}If you create a wiki in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, only {% ifversion fpt or ghes or ghec %}people{% elsif ghae %}enterprise members{% endif %} with access to the repository can access the wiki. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." diff --git a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index 95fb65a300..a1b8206e12 100644 --- a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -46,6 +46,11 @@ You can link to an image in a repository on {% data variables.product.product_na [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] +{% ifversion math %} +## Adding mathematical expressions{% ifversion mermaid %} and diagrams{% endif %}{% endif %} + +{% data reusables.getting-started.math-and-diagrams %} + ## Supported MediaWiki formats No matter which markup language your wiki page is written in, certain MediaWiki syntax will always be available to you. diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md index 8d0b98c315..bcd9ed27f2 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md @@ -8,7 +8,7 @@ shortTitle: Create diagrams ## About creating diagrams -You can create diagrams in Markdown using three different syntaxes: mermaid, geoJSON and topoJSON, and ASCII STL. +You can create diagrams in Markdown using three different syntaxes: mermaid, geoJSON and topoJSON, and ASCII STL. Diagram rendering is {% data reusables.getting-started.available-throughout %} ## Creating Mermaid diagrams diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index 443ac80528..20360675b3 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -6,10 +6,14 @@ versions: shortTitle: Mathematical expressions --- +## About writing mathematical expressions + To enable clear communication of mathematical expressions, {% data variables.product.product_name %} supports LaTeX formatted math within Markdown. For more information, see [LaTeX/Mathematics](http://en.wikibooks.org/wiki/LaTeX/Mathematics) in Wikibooks. {% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide). +Mathematical expressions rendering is {% data reusables.getting-started.available-throughout %} + ## Writing inline expressions To include a math expression inline with your text, delimit the expression with a dollar symbol `$`. diff --git a/data/reusables/getting-started/available-throughout.md b/data/reusables/getting-started/available-throughout.md new file mode 100644 index 0000000000..3133e543e6 --- /dev/null +++ b/data/reusables/getting-started/available-throughout.md @@ -0,0 +1 @@ +available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, Markdown files, and wikis. diff --git a/data/reusables/getting-started/math-and-diagrams.md b/data/reusables/getting-started/math-and-diagrams.md new file mode 100644 index 0000000000..12f17c6856 --- /dev/null +++ b/data/reusables/getting-started/math-and-diagrams.md @@ -0,0 +1 @@ +{% ifversion math %}You can use Markdown to add rendered math expressions{% ifversion mermaid %}, diagrams, maps, and 3D models{% endif %} to your wiki. For more information on creating rendered math expressions, see "[Writing mathematical expressions](/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)."{% ifversion mermaid %} For more information on creating diagrams, maps and 3D models, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."{% endif %}{% endif %} \ No newline at end of file From 475e4fa28ece8c1f23fa01d16199e9b7af95d46a Mon Sep 17 00:00:00 2001 From: Jules Parker <19994093+jules-p@users.noreply.github.com> Date: Thu, 4 Aug 2022 11:44:54 +0200 Subject: [PATCH 2/5] fix versioning --- .../editing-wiki-content.md | 4 ++-- .../working-with-advanced-formatting/creating-diagrams.md | 2 +- .../writing-mathematical-expressions.md | 2 +- data/reusables/getting-started/available-throughout.md | 1 - data/reusables/getting-started/math-and-diagrams.md | 2 +- 5 files changed, 5 insertions(+), 6 deletions(-) delete mode 100644 data/reusables/getting-started/available-throughout.md diff --git a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index a1b8206e12..f496dcf094 100644 --- a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -46,8 +46,8 @@ You can link to an image in a repository on {% data variables.product.product_na [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -{% ifversion math %} -## Adding mathematical expressions{% ifversion mermaid %} and diagrams{% endif %}{% endif %} +{% ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %} +## Adding mathematical expressions and diagrams{% endif %} {% data reusables.getting-started.math-and-diagrams %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md index bcd9ed27f2..4b690277a2 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md @@ -8,7 +8,7 @@ shortTitle: Create diagrams ## About creating diagrams -You can create diagrams in Markdown using three different syntaxes: mermaid, geoJSON and topoJSON, and ASCII STL. Diagram rendering is {% data reusables.getting-started.available-throughout %} +You can create diagrams in Markdown using three different syntaxes: mermaid, geoJSON and topoJSON, and ASCII STL. Diagram rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, wikis, and Markdown files. ## Creating Mermaid diagrams diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index 20360675b3..2a01789396 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -12,7 +12,7 @@ To enable clear communication of mathematical expressions, {% data variables.pro {% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide). -Mathematical expressions rendering is {% data reusables.getting-started.available-throughout %} +Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %}wikis, {% endif %}and Markdown files. ## Writing inline expressions diff --git a/data/reusables/getting-started/available-throughout.md b/data/reusables/getting-started/available-throughout.md deleted file mode 100644 index 3133e543e6..0000000000 --- a/data/reusables/getting-started/available-throughout.md +++ /dev/null @@ -1 +0,0 @@ -available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, Markdown files, and wikis. diff --git a/data/reusables/getting-started/math-and-diagrams.md b/data/reusables/getting-started/math-and-diagrams.md index 12f17c6856..0b8fd102b4 100644 --- a/data/reusables/getting-started/math-and-diagrams.md +++ b/data/reusables/getting-started/math-and-diagrams.md @@ -1 +1 @@ -{% ifversion math %}You can use Markdown to add rendered math expressions{% ifversion mermaid %}, diagrams, maps, and 3D models{% endif %} to your wiki. For more information on creating rendered math expressions, see "[Writing mathematical expressions](/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)."{% ifversion mermaid %} For more information on creating diagrams, maps and 3D models, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."{% endif %}{% endif %} \ No newline at end of file +{% ifversion mermaid %}You can use Markdown to add rendered math expressions, diagrams, maps, and 3D models to your wiki. For more information on creating rendered math expressions, see "[Writing mathematical expressions](/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)." For more information on creating diagrams, maps and 3D models, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."{% endif %} \ No newline at end of file From 53c24149555d97f182131e27ee13b699db50f063 Mon Sep 17 00:00:00 2001 From: Jules Parker <19994093+jules-p@users.noreply.github.com> Date: Thu, 4 Aug 2022 12:09:35 +0200 Subject: [PATCH 3/5] fix versioning --- .../documenting-your-project-with-wikis/editing-wiki-content.md | 2 +- .../writing-mathematical-expressions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index f496dcf094..b37efa2281 100644 --- a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -46,7 +46,7 @@ You can link to an image in a repository on {% data variables.product.product_na [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -{% ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %} +{% ifversion fpt or ghec or ghes > 3.6 or ghae %} ## Adding mathematical expressions and diagrams{% endif %} {% data reusables.getting-started.math-and-diagrams %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index 2a01789396..8a118c0e7a 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -12,7 +12,7 @@ To enable clear communication of mathematical expressions, {% data variables.pro {% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide). -Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %}wikis, {% endif %}and Markdown files. +Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae %}wikis, {% endif %}and Markdown files. ## Writing inline expressions From a5d9cb44d9922eb5be7e5131fb35549f9fd78550 Mon Sep 17 00:00:00 2001 From: Jules Parker <19994093+jules-p@users.noreply.github.com> Date: Mon, 8 Aug 2022 08:40:12 +0200 Subject: [PATCH 4/5] fix versioning --- .../documenting-your-project-with-wikis/editing-wiki-content.md | 2 +- .../writing-mathematical-expressions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index b37efa2281..a1e4a89466 100644 --- a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -46,7 +46,7 @@ You can link to an image in a repository on {% data variables.product.product_na [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -{% ifversion fpt or ghec or ghes > 3.6 or ghae %} +{% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-6054 %} ## Adding mathematical expressions and diagrams{% endif %} {% data reusables.getting-started.math-and-diagrams %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index 8a118c0e7a..d63aa3736d 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -12,7 +12,7 @@ To enable clear communication of mathematical expressions, {% data variables.pro {% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide). -Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae %}wikis, {% endif %}and Markdown files. +Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-6054 %}wikis, {% endif %}and Markdown files. ## Writing inline expressions From 74edd43f0f20af98c8a1a322628f8ce0a4e2ddbb Mon Sep 17 00:00:00 2001 From: Jules Parker <19994093+jules-p@users.noreply.github.com> Date: Mon, 8 Aug 2022 10:17:59 +0200 Subject: [PATCH 5/5] fix versioning --- .../documenting-your-project-with-wikis/editing-wiki-content.md | 2 +- .../writing-mathematical-expressions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index a1e4a89466..32dcbdc4b5 100644 --- a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -46,7 +46,7 @@ You can link to an image in a repository on {% data variables.product.product_na [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -{% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-6054 %} +{% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7647 %} ## Adding mathematical expressions and diagrams{% endif %} {% data reusables.getting-started.math-and-diagrams %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index d63aa3736d..94b2e2bec0 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -12,7 +12,7 @@ To enable clear communication of mathematical expressions, {% data variables.pro {% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide). -Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-6054 %}wikis, {% endif %}and Markdown files. +Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7647 %}wikis, {% endif %}and Markdown files. ## Writing inline expressions