diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..39bbd2681 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,4 @@ +{ + "image": "mcr.microsoft.com/devcontainers/universal:2", + "features": {} +} diff --git a/.github/workflows/jekyll-docker.yml b/.github/workflows/jekyll-docker.yml new file mode 100644 index 000000000..60e57369d --- /dev/null +++ b/.github/workflows/jekyll-docker.yml @@ -0,0 +1,20 @@ +name: Jekyll site CI + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Build the site in the jekyll/builder container + run: | + docker run \ + -v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \ + jekyll/builder:latest /bin/bash -c "chmod -R 777 /srv/jekyll && jekyll build --future" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index fa7424847..f9d8852ef 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -2,7 +2,7 @@ name: tests on: [push, pull_request] jobs: test-links: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1 diff --git a/Gemfile b/Gemfile index 25e4b31ae..a0d4a3779 100644 --- a/Gemfile +++ b/Gemfile @@ -3,7 +3,7 @@ source 'https://rubygems.org' group :development do - gem 'jekyll', '~> 4.2.0' + gem 'jekyll', '~> 4.4.1' gem 'jekyll-sitemap' gem 'jekyll-last-modified-at' end @@ -13,4 +13,4 @@ group :test do gem 'html-proofer' end -gem "webrick", "~> 1.7" +gem "webrick", "~> 1.8" diff --git a/Gemfile.lock b/Gemfile.lock index 12ac9a281..acd1ec3a2 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,32 +1,42 @@ GEM remote: https://rubygems.org/ specs: - Ascii85 (1.1.0) - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - afm (0.2.2) - async (2.7.0) - console (~> 1.10) + Ascii85 (2.0.1) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + afm (1.0.0) + async (2.34.0) + console (~> 1.29) fiber-annotation - io-event (~> 1.1) - timers (~> 4.1) + io-event (~> 1.11) + metrics (~> 0.12) + traces (~> 0.18) + base64 (0.3.0) + bigdecimal (3.3.1) colorator (1.1.0) - concurrent-ruby (1.2.2) - console (1.23.3) + concurrent-ruby (1.3.5) + console (1.34.2) fiber-annotation - fiber-local + fiber-local (~> 1.1) + json + csv (3.3.5) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) - ethon (0.16.0) + ethon (0.17.0) ffi (>= 1.15.0) eventmachine (1.2.7) - ffi (1.16.3) + ffi (1.17.2) fiber-annotation (0.2.0) - fiber-local (1.0.0) + fiber-local (1.1.0) + fiber-storage + fiber-storage (1.0.1) forwardable-extended (2.6.0) + google-protobuf (4.33.0) + bigdecimal + rake (>= 13) hashery (2.1.2) - html-proofer (5.0.8) + html-proofer (5.0.10) addressable (~> 2.3) async (~> 2.1) nokogiri (~> 1.13) @@ -36,89 +46,95 @@ GEM yell (~> 2.0) zeitwerk (~> 2.5) http_parser.rb (0.8.0) - i18n (1.14.1) + i18n (1.14.7) concurrent-ruby (~> 1.0) - io-event (1.4.0) - jekyll (4.2.2) + io-event (1.11.2) + jekyll (4.4.1) addressable (~> 2.4) + base64 (~> 0.2) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) i18n (~> 1.0) - jekyll-sass-converter (~> 2.0) + jekyll-sass-converter (>= 2.0, < 4.0) jekyll-watch (~> 2.0) - kramdown (~> 2.3) + json (~> 2.6) + kramdown (~> 2.3, >= 2.3.1) kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (~> 0.4.0) + mercenary (~> 0.3, >= 0.3.6) pathutil (~> 0.9) - rouge (~> 3.0) + rouge (>= 3.0, < 5.0) safe_yaml (~> 1.0) - terminal-table (~> 2.0) - jekyll-last-modified-at (1.3.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-last-modified-at (1.3.2) jekyll (>= 3.7, < 5.0) - posix-spawn (~> 0.3.9) - jekyll-sass-converter (2.2.0) - sassc (> 2.0.1, < 3.0) + jekyll-sass-converter (3.1.0) + sass-embedded (~> 1.75) jekyll-sitemap (1.4.0) jekyll (>= 3.7, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - kramdown (2.4.0) - rexml + json (2.15.1) + kramdown (2.5.1) + rexml (>= 3.3.9) kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.8.0) + listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) - mini_portile2 (2.8.5) - nokogiri (1.16.0) + metrics (0.15.0) + mini_portile2 (2.8.9) + nokogiri (1.18.10) mini_portile2 (~> 2.8.2) racc (~> 1.4) pathutil (0.16.2) forwardable-extended (~> 2.6) - pdf-reader (2.12.0) - Ascii85 (~> 1.0) - afm (~> 0.2.1) + pdf-reader (2.15.0) + Ascii85 (>= 1.0, < 3.0, != 2.0.0) + afm (>= 0.2.1, < 2) hashery (~> 2.0) ruby-rc4 ttfunk - posix-spawn (0.3.15) - public_suffix (5.0.4) - racc (1.7.3) + public_suffix (6.0.2) + racc (1.8.1) rainbow (3.1.1) - rake (13.1.0) + rake (13.3.0) rb-fsevent (0.11.2) - rb-inotify (0.10.1) + rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.2.6) - rouge (3.30.0) + rexml (3.4.4) + rouge (4.6.1) ruby-rc4 (0.1.5) safe_yaml (1.0.5) - sassc (2.4.0) - ffi (~> 1.9) - terminal-table (2.0.0) - unicode-display_width (~> 1.1, >= 1.1.1) - timers (4.3.5) - ttfunk (1.7.0) + sass-embedded (1.93.2) + google-protobuf (~> 4.31) + rake (>= 13) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + traces (0.18.2) + ttfunk (1.8.0) + bigdecimal (~> 3.1) typhoeus (1.4.1) ethon (>= 0.9.0) - unicode-display_width (1.8.0) - webrick (1.8.1) + unicode-display_width (2.6.0) + webrick (1.9.1) yell (2.2.2) - zeitwerk (2.6.12) + zeitwerk (2.7.3) PLATFORMS ruby DEPENDENCIES html-proofer - jekyll (~> 4.2.0) + jekyll (~> 4.4.1) jekyll-last-modified-at jekyll-sitemap rake - webrick (~> 1.7) + webrick (~> 1.8) BUNDLED WITH 2.4.19 diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..2d58298e6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,428 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. + diff --git a/LICENSE.txt b/LICENSE-CODE similarity index 96% rename from LICENSE.txt rename to LICENSE-CODE index 08ce3058f..d35599616 100644 --- a/LICENSE.txt +++ b/LICENSE-CODE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Matt Cone +Copyright (c) 2017-2025 Matt Cone Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f0a3035be..612a43490 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Markdown Guide -[![Build Status](https://github.com/mattcone/markdown-guide/workflows/tests/badge.svg?branch=master)](https://github.com/mattcone/markdown-guide/actions) - *[The Markdown Guide](https://www.markdownguide.org)* is a comprehensive Markdown reference designed for both novices and experts. It was born out of frustration with existing Markdown references that are incomplete and inadequate. ## Contributing @@ -23,4 +21,4 @@ See [this page](https://github.com/mattcone/markdown-guide/wiki/Markdown-tool-di ## License -The content of this project itself is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](LICENSE.txt). +The content of this project itself is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](LICENSE), and the underlying source code used to format and display that content is licensed under the [MIT license](LICENSE-CODE). diff --git a/Rakefile b/Rakefile index 70beff192..64e45578f 100644 --- a/Rakefile +++ b/Rakefile @@ -16,7 +16,10 @@ task :test do 'https://twitter.com/datamorgan/status/1109518506125451264', 'https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-', %r{https://dpaste.com/*}, - %r{https://www.reddit.com/*}], + %r{https://hedgedoc.org/*}, + %r{https://docs.hedgedoc.org/*}, + %r{https://www.reddit.com/*}, + %r{https://stackoverflow.com/*}], :url_swap => { %r{https://www.markdownguide.org} => '' }, :typhoeus => { :ssl_verifypeer => false, diff --git a/_basic-syntax/images.md b/_basic-syntax/images.md index f4ab351f5..6265c6cc2 100644 --- a/_basic-syntax/images.md +++ b/_basic-syntax/images.md @@ -5,8 +5,8 @@ syntax-summary: "![alt text](image.jpg)" description: "To add an image, add an exclamation mark (`!`), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title after the URL in the parentheses." examples: - markdown: | - ![The San Juan Mountains are beautiful!](/assets/images/san-juan-mountains.jpg "San Juan Mountains") - html: \"The + ![The San Juan Mountains are beautiful](/assets/images/san-juan-mountains.jpg "San Juan Mountains") + html: \"The additional-examples: - name: "Linking Images" description: "To add a link to an image, enclose the Markdown for the image in brackets, and then add the link in parentheses." @@ -18,12 +18,12 @@ additional-examples: To add an image, add an exclamation mark (`!`), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL. ``` -![The San Juan Mountains are beautiful!](/assets/images/san-juan-mountains.jpg "San Juan Mountains") +![The San Juan Mountains are beautiful](/assets/images/san-juan-mountains.jpg "San Juan Mountains") ``` The rendered output looks like this: -{% include image.html file="/assets/images/san-juan-mountains.jpg" alt="The San Juan Mountains are beautiful!" title="San Juan Mountains" lazy="yes" %} +{% include image.html file="/assets/images/san-juan-mountains.jpg" alt="The San Juan Mountains are beautiful" title="San Juan Mountains" lazy="yes" %}
Note: To resize an image, see the section on image size. To add a caption, see the section on image captions. diff --git a/_getting-started/whats-markdown-good-for.md b/_getting-started/whats-markdown-good-for.md index 46fa8d8c7..7a0bb4694 100644 --- a/_getting-started/whats-markdown-good-for.md +++ b/_getting-started/whats-markdown-good-for.md @@ -15,7 +15,7 @@ If you're looking for the simplest possible way to create a website with Markdow If you're familiar with HTML, CSS, and version control, check out [Jekyll](/tools/jekyll/), a popular static site generator that takes Markdown files and builds an HTML website. One advantage to this approach is that [GitHub Pages](/tools/github-pages/) provides free hosting for Jekyll-generated websites. If Jekyll isn't your cup of tea, just pick one of the [many other static site generators available](https://jamstack.org/generators/).
- Note: I used Jekyll to create the Markdown Guide. You can view the source code on GitHub. + Note: Shameless plug! If you want to learn how to build static websites from scratch, check out The Static Site Guide, another book I wrote.
If you'd like to use a content management system (CMS) to power your website, take a look at [Ghost](/tools/ghost/). It's a free and open-source blogging platform with a nice Markdown editor. If you're a WordPress user, you'll be happy to know there's [Markdown support](https://wordpress.com/support/wordpress-editor/blocks/markdown-block/) for websites hosted on WordPress.com. Self-hosted WordPress sites can use the [Jetpack plugin](https://jetpack.com/support/jetpack-blocks/markdown/). diff --git a/_tools/airsend.md b/_tools/airsend.md index 5df59d780..4cb44d0c6 100644 --- a/_tools/airsend.md +++ b/_tools/airsend.md @@ -63,9 +63,6 @@ syntax: available: n - id: html available: n -see-also: - - name: AirSend Markdown Cheatsheet - link: https://www.airsend.io/blog/index.php/2020/02/19/how-to-format-a-message-using-markdown-language/ --- [AirSend](https://www.airsend.io/) is a collaboration application that's great for keeping track of notes, formatting documents, and publishing status reports. This application allows users to see their notes and status reports in Markdown-formatted text. While typing your notes, other users can see the live preview on their screens. AirSend is available for macOS, iOS, Android, Windows, and Linux. diff --git a/_tools/blot.md b/_tools/blot.md new file mode 100644 index 000000000..2ae8f57d7 --- /dev/null +++ b/_tools/blot.md @@ -0,0 +1,71 @@ +--- +title: Blot +category: "websites" +description: "Blot is an open source CMS which turns a folder into a website." +icon: blot.png +website: https://blot.im/ +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: y + - id: heading-ids + available: y + - id: definition-lists + available: y + - id: strikethrough + available: y + - id: task-lists + available: y + - id: emoji-cp + available: y + - id: emoji-sc + available: n + - id: highlight + available: y + - id: subscript + available: y + - id: superscript + available: y + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: y +--- +[Blot](https://blot.im) is a simple content management system (CMS) that transforms a folder on your computer into a fully functional website. It supports automatic publishing for various file types, including [Markdown files](https://blot.im/how/files/markdown). + +Any Markdown file you place in the synced folder instantly becomes a post on your website. You can also embed images in Markdown files, whether they’re hosted online or stored locally in the same folder. + +Blot offers robust Markdown support, leveraging Pandoc for parsing and rendering, along with additional extensions to enhance functionality. + +{% include tool-syntax-table.html %} diff --git a/_tools/buttondown.md b/_tools/buttondown.md new file mode 100644 index 000000000..8cd565de9 --- /dev/null +++ b/_tools/buttondown.md @@ -0,0 +1,76 @@ +--- +title: Buttondown +category: "email" +description: "Buttondown is an email platform to run your newsletter." +icon: buttondown.png +website: https://buttondown.com/ +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: n + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: y + - id: heading-ids + available: p + notes: "Automatically generated. There's no way to set custom heading IDs." + - id: definition-lists + available: n + - id: strikethrough + available: y + - id: task-lists + available: n + - id: emoji-cp + available: y + - id: emoji-sc + available: n + - id: highlight + available: n + - id: subscript + available: y + - id: superscript + available: y + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: n + - id: html + available: p + notes: "Some HTML is sanitized." +--- + +[Buttondown](https://buttondown.com) is an email platform, similar to the now-defunct [TinyLetter](https://buttondown.com/comparisons/tinyletter), that allows you to send emails to subscribers. It also has integrations with many other platforms to automatically publish or add subscribers, amongst other possibilities. + +The email editor [supports Markdown](https://buttondown.com/features/markdown), with the possibility to switch to a WYSIWYG editor for those who prefer it. + +{% include image.html file="/assets/images/tools/buttondown.png" alt="Buttondown email editor" %} + +There are a couple minor compatibility issues noted below but, generally speaking, Buttondown has solid Markdown support. According to [their docs](https://docs.buttondown.com/using-markdown), it uses Python-Markdown for parsing and rendering along with a few extensions. The live editor is fairly intuitive and gives you a preview on how the email will look in both the archive and in email clients like Gmail. Copying and pasting Markdown-formatted text into the editor works the way you'd expect it to. + +{% include tool-syntax-table.html %} diff --git a/_tools/codimd.md b/_tools/codimd.md index 6cc4b4fd1..69da7b2d4 100644 --- a/_tools/codimd.md +++ b/_tools/codimd.md @@ -62,8 +62,8 @@ syntax: - id: html available: y see-also: - - name: CodiMD features - link: https://codimd-app.herokuapp.com/features + - name: CodiMD documentation + link: https://hackmd.io/c/codimd-documentation/ --- [CodiMD](https://github.com/hackmdio/codimd) is an open-source real-time collaborative Markdown editor. You can easily [deploy CodiMD with Docker following this tutorial](https://hackmd.io/s/codimd-docker-deployment). CodiMD supports CommonMark and other markup syntax, such as: diff --git a/_tools/discord.md b/_tools/discord.md index 7c4d3826c..ce57ad56b 100644 --- a/_tools/discord.md +++ b/_tools/discord.md @@ -29,8 +29,7 @@ syntax: - id: horizontal-rules available: n - id: links - available: p - notes: "Not fully supported. See this [GitHub issue](https://github.com/discord/discord-api-docs/issues/6450) for more information." + available: y - id: images available: n - id: tables @@ -99,5 +98,10 @@ As an added bonus, Discord provides support for several obscure elements. __This text will be underlined.__ This text will be underlined. + + Subtext + -# This line will be made smaller and greyed out. + This line will be made smaller and greyed out. + diff --git a/_tools/docusaurus.md b/_tools/docusaurus.md index 502279801..e6ff39a7f 100644 --- a/_tools/docusaurus.md +++ b/_tools/docusaurus.md @@ -71,6 +71,6 @@ see-also: Docusaurus uses the [remarkable](https://github.com/jonschlinkert/remarkable) Markdown processor. -{% include image.html file="/assets/images/tools/Docusaurus.png" alt="Example of Docusaurus website" %} +{% include image.html file="/assets/images/tools/docusaurus.png" alt="Example of Docusaurus website" %} {% include tool-syntax-table.html %} diff --git a/_tools/joplin.md b/_tools/joplin.md index 5d132bc89..2d580e33d 100644 --- a/_tools/joplin.md +++ b/_tools/joplin.md @@ -70,7 +70,7 @@ see-also: link: https://joplinapp.org --- -[Joplin](https://joplinapp.org) is a free and open-source note taking application that works on every platform. Joplin's user interface isn't as polished as some of its competitors — it feels more geeky, if that makes any sense — but the application is a favorite among privacy advocates and is recommended by [Privacy Guides](https://www.privacyguides.org/notebooks/). Joplin stores notes on your local file system, provides end-to-end encryption, and allows you to synchronize files across devices by storing them on a service like Dropbox or Nextcloud. Or, you can subscribe to [Joplin Cloud](https://joplinapp.org/plans/) for syncing. +[Joplin](https://joplinapp.org) is a free and open-source note taking application that works on every platform. Joplin's user interface isn't as polished as some of its competitors — it feels more geeky, if that makes any sense — but the application is a favorite among privacy advocates and is recommended by [Privacy Guides](https://www.privacyguides.org/en/notebooks/). Joplin stores notes on your local file system, provides end-to-end encryption, and allows you to synchronize files across devices by storing them on a service like Dropbox or Nextcloud. Or, you can subscribe to [Joplin Cloud](https://joplinapp.org/plans/) for syncing. {% include image.html file="/assets/images/tools/joplin.png" alt="Joplin Markdown application" width="90" %} diff --git a/_tools/madoko.md b/_tools/madoko.md index 141186f51..cde8ca238 100644 --- a/_tools/madoko.md +++ b/_tools/madoko.md @@ -3,7 +3,7 @@ title: Madoko category: documents description: "Madoko is an application for writing professional articles and more." icon: madoko.png -website: https://www.madoko.net/ +website: https://github.com/koka-lang/madoko syntax: - id: headings available: y @@ -32,7 +32,7 @@ syntax: notes: "Images can be dropped into the document to be automatically uploaded and linked to a sub-directory of the document's folder. Just watch the file size as images larger than about 1Mb are rejected by the Madoko server." - id: tables available: y - notes: "Madoko significantly extends the [table syntax](https://madoko.org/reference.html#sec-table) of basic Markdown." + notes: "Madoko significantly extends the table syntax of basic Markdown." - id: fenced-code-blocks available: y - id: syntax-highlighting @@ -64,13 +64,10 @@ syntax: available: n - id: html available: p - notes: "See the [Madoko Reference](https://madoko.org/reference.html#sec-custom) for more information on custom blocks." -see-also: - - name: Madoko Reference - link: https://madoko.org/reference.html + notes: "See the Madoko Reference for more information on custom blocks." --- -[Madoko](https://www.madoko.net/) is a fast Markdown processor for writing professional articles, books, manuals, webpages and presentations, with a focus on simplicity and plain text readability. You can use Madoko to write complex documents in Markdown and get beautiful PDF and HTML output. Madoko is a Javascript Markdown processor written in Koka. It started out as a demo program for the new, strongly typed, Koka language and the name comes from "Markdown in Koka." +[Madoko](https://github.com/koka-lang/madoko) is a fast Markdown processor for writing professional articles, books, manuals, webpages and presentations, with a focus on simplicity and plain text readability. You can use Madoko to write complex documents in Markdown and get beautiful PDF and HTML output. Madoko is a Javascript Markdown processor written in Koka. It started out as a demo program for the new, strongly typed, Koka language and the name comes from "Markdown in Koka." Madoko can both be run locally as a command-line program or on Madoko.net to take advantage of storage and collaboration features. Madoko integrates seamlessly with Dropbox, Github, and OneDrive. It automatically synchronizes all changes in the cloud. This way, your document is always available from any device. The online editor can also edit files on the local disk, or run LaTeX locally, using the Madoko local program. diff --git a/_tools/markdown-space.md b/_tools/markdown-space.md new file mode 100644 index 000000000..4640bc853 --- /dev/null +++ b/_tools/markdown-space.md @@ -0,0 +1,76 @@ +--- +title: Markdown Space +category: 'websites' +description: 'Build beautiful, fast, and responsive websites with Markdown.' +icon: markdown-space.png +website: https://markdown.space +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: n + - id: heading-ids + available: p + notes: "Automatically generated. There's no way to set custom heading IDs." + - id: definition-lists + available: n + - id: strikethrough + available: n + - id: task-lists + available: y + - id: emoji-cp + available: n + - id: emoji-sc + available: n + - id: highlight + available: y + - id: subscript + available: n + - id: superscript + available: n + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: y +see-also: + - name: Markdown Space Documentation + link: https://markdown.space/documentation +--- + +[Markdown Space](https://markdown.space) is a platform for building beautiful, fast, and responsive websites with Markdown syntax. Host your site on a custom domain and get the benefits of the [Cloudflare Supercloud](https://blog.cloudflare.com/welcome-to-the-supercloud-and-developer-week-2022/). Generate content with the help of AI, and add JSX components with support for [MDX](https://mdxjs.com). Leverage the beauty of [Bootswatch](https://bootswatch.com) themes. + +See the [Quick start](https://markdown.space/getting-started) guide for more details. + +{% include image.html file="/assets/images/tools/markdown-space.png" alt="Markdown Space" width="100" %} + +{% include tool-syntax-table.html %} diff --git a/_tools/mart.md b/_tools/mart.md new file mode 100644 index 000000000..fe06e93e0 --- /dev/null +++ b/_tools/mart.md @@ -0,0 +1,73 @@ +--- +title: MART +category: "documents" +description: "Simple QT GUI for the Markdown Tool." +icon: mart.png +website: https://github.com/artiomn/mart_gui +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: n + - id: heading-ids + available: n + - id: definition-lists + available: n + - id: strikethrough + available: y + - id: task-lists + available: y + - id: emoji-cp + available: y + - id: emoji-sc + available: n + - id: highlight + available: n + - id: subscript + available: n + - id: superscript + available: n + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: y +see-also: + - name: Markdown Tool + link: https://github.com/artiomn/markdown_articles_tool +--- + +[Markdown ARticles Tool GUI](https://github.com/artiomn/mart_gui) is a Qt GUI for the [Markdown Articles Tool](https://github.com/artiomn/markdown_articles_tool). You can download text with images using deduplication and convert to different formats. The Markdown ARticles Tool GUI is available for macOS, Windows, and Linux. + +{% include image.html file="/assets/images/tools/mart.png" alt="Markdown Articles Tool QT GUI" %} + +{% include tool-syntax-table.html %} diff --git a/_tools/teedoc.md b/_tools/teedoc.md new file mode 100644 index 000000000..423f44134 --- /dev/null +++ b/_tools/teedoc.md @@ -0,0 +1,140 @@ +--- +title: teedoc +category: "websites" +description: "Static doc site generator from Markdown and jupyter, written with Python." +icon: teedoc.png +website: https://teedoc.github.io +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: y + - id: heading-ids + available: y + - id: definition-lists + available: y + - id: strikethrough + available: y + - id: task-lists + available: y + - id: emoji-cp + available: y + - id: emoji-sc + available: n + - id: highlight + available: n + - id: subscript + available: y + - id: superscript + available: y + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: y +see-also: + - name: teedoc Markdown Features + link: https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html +--- + +[teedoc](https://teedoc.github.io) is an open-source static site generator that converts Markdown files and jupyter notebooks to a documentation website. teedoc is written in the Python programming language, easy to use and extend. teedoc is especially suitable for multiple documentation sites, wikis, or knowledge bases. + +teedoc uses the [mistune](https://github.com/lepture/mistune) Markdown parser. + +{% include image.html file="/assets/images/tools/teedoc.png" alt="Example of teedoc website" %} + +{% include tool-syntax-table.html %} + +### Support for Additional Syntax Elements + +teedoc supports many useful additional syntax like: + +* [mermaid](https://mermaid-js.github.io/mermaid/): A simple markdown-like script language for generating charts from text via javascript. +* math: Supports Latex, tex math syntax, and MathML tags. +* tabset: A easy to use tabset syntax. For example, it shows different code examples for different programming languages. + + ```markdown + .. tabset:: + :id: tabset1 + + ## Kotlin + + Content 1, full Markdown syntax support + + ## Java + + Content 2, full Markdown syntax support + ``` + + will be rendered to: + + ```html +
+
Title(optional)
+
+
+ Kotlin + Java +
+
+
+

Content 1, full Markdown syntax support

+
+
+

Content 2, full Markdown syntax support

+
+
+
+
+ ``` + +* details: A syntax to generate HTML5 details tag. + + ```markdown + .. details::Title, click to expand + + Content, full Markdown syntax support + ``` + + will be rendered to: + + ```html +
+ Title, click to expand +
+

Content, full Markdown syntax support

+
+
+ ``` + +For more syntax information, visit [teedoc markdown syntax](https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html). + diff --git a/_tools/typemill.md b/_tools/typemill.md new file mode 100644 index 000000000..ee147e138 --- /dev/null +++ b/_tools/typemill.md @@ -0,0 +1,74 @@ +--- +title: Typemill +category: "websites" +description: "Typemill is an open source CMS for websites and ebooks in pdf- and epub-format." +icon: typemill.png +website: https://typemill.net +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: p + notes: "Syntax highlighting available in the raw markdown editor and in frontend with a plugin possible." + - id: footnotes + available: y + - id: heading-ids + available: y + notes: "Can be activated in the settings." + - id: definition-lists + available: y + - id: strikethrough + available: n + - id: task-lists + available: n + - id: emoji-cp + available: n + - id: emoji-sc + available: n + - id: highlight + available: n + - id: subscript + available: n + - id: superscript + available: y + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: n + - id: html + available: p + notes: "HTML is off by default for security reasons but you can use various html-tags with a plugin that utilizes the shortcode feature." +--- +[Typemill](https://typemill.net) is a lightweight content management system (CMS) for creating websites and ebooks in PDF and ePub formats. Typemill is especially popular among small and mid-sized companies for creating documentation and manuals for software, physical products, and services. + +{% include image.html file="/assets/images/tools/typemill.gif" alt="Typemill markdown editor" %} + +Typemill is built with Vue.js and PHP. It uses the widely adopted Parsedown library for Markdown conversion. + +{% include tool-syntax-table.html %} diff --git a/_tools/wikibonsai.md b/_tools/wikibonsai.md new file mode 100644 index 000000000..c7f29ea3b --- /dev/null +++ b/_tools/wikibonsai.md @@ -0,0 +1,92 @@ +--- +title: WikiBonsai +category: + - notes + - websites +description: "WikiBonsai is collection of open source tools for markdown-based digital gardening." +icon: wikibonsai.png +website: https://github.com/wikibonsai/wikibonsai +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + notes: "Image display in preview is subject to content security policy, adjustable from the drop-down menu to the top-right" + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: p + notes: "In code editor only. Comprehensive support requires the [Markdown Preview Enhanced extension](https://github.com/shd101wyy/vscode-markdown-preview-enhanced)." + - id: heading-ids + available: p + notes: "Does not support custom IDs. Comprehensive support requires the [Markdown Preview Enhanced extension](https://github.com/shd101wyy/vscode-markdown-preview-enhanced)." + - id: definition-lists + available: p + notes: "Requires the [Markdown Preview Enhanced extension](https://github.com/shd101wyy/vscode-markdown-preview-enhanced)." + - id: strikethrough + available: p + notes: "Two tildes (`~~word~~`) only." + - id: task-lists + available: p + notes: "One of the many readily available extensions can add this feature, e.g. [Markdown Preview Enhanced](https://github.com/shd101wyy/vscode-markdown-preview-enhanced)." + - id: emoji-cp + available: y + - id: emoji-sc + available: p + notes: "Requires the [Markdown Preview Enhanced extension](https://github.com/shd101wyy/vscode-markdown-preview-enhanced)." + - id: highlight + available: n + - id: subscript + available: n + - id: superscript + available: n + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: y +--- + +[WikiBonsai](https://github.com/wikibonsai/wikibonsai) is a collection of open source tools to bring digital gardening workflows to markdown. + +{% include image.html file="/assets/images/tools/wikibonsai-demo.png" alt="vscode-wikibonsai" %} + +Key workflows: + +- Extended `[[wiki]]` syntax including attributes, links, and embeds. +- A "semantic tree" or "knowledge bonsai" structure to organize your markdown documents. +- Graphical visualizations to explore your notes in 2D, 3D, AR, VR or map to embeddings (often used in deep learning in AI). +- CAML: Colon Attribute Markup Language a light, YAML-like markup for semantic attributes (with [[wiki]] support!). + +Top-level tools: + +- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=manunamz.vscode-wikibonsai) +- [CLI Tool](https://github.com/wikibonsai/tendr-cli) + +{% include tool-syntax-table.html %} + diff --git a/_tools/writerside.md b/_tools/writerside.md new file mode 100644 index 000000000..58e0899e9 --- /dev/null +++ b/_tools/writerside.md @@ -0,0 +1,72 @@ +--- +title: Writerside +category: "websites" +description: "Writerside is a new technical authoring and publishing environment from JetBrains." +icon: writerside.png +website: https://www.jetbrains.com/writerside/ +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: n + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + notes: "By default, the blockquotes markup will turn into an admonition block called a tip. One can change the block type to note or warning. Read more here: ." + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: n + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: n + - id: heading-ids + available: y + - id: definition-lists + available: y + - id: strikethrough + available: y + - id: task-lists + available: n + - id: emoji-cp + available: y + - id: emoji-sc + available: n + - id: highlight + available: n + - id: subscript + available: y + - id: superscript + available: y + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: n +--- + +[Writerside](https://www.jetbrains.com/writerside/) is a new technical authoring and publishing environment from JetBrains. It consists of an editor, a static site builder, and a customizable frontend tailored specifically for technical documentation. +Created by JetBrains, Writerside is based on the IntelliJ platform. + +Writerside uses the [flexmark](https://github.com/vsch/flexmark-java) Markdown processor. + +{% include tool-syntax-table.html %} diff --git a/about.md b/about.md index a7fb2d3b3..e9b14b3ef 100644 --- a/about.md +++ b/about.md @@ -26,7 +26,7 @@ Use the [contact form](/contact/) to send a message to the maintainer of *The Ma ## License -The content of this project itself is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](https://github.com/mattcone/markdown-guide/blob/master/LICENSE.txt). +The content of this project itself is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](https://github.com/mattcone/markdown-guide/blob/master/LICENSE-CODE). ## Affiliate Links diff --git a/assets/images/tool-icons/blot.png b/assets/images/tool-icons/blot.png new file mode 100644 index 000000000..2d9e2c10c Binary files /dev/null and b/assets/images/tool-icons/blot.png differ diff --git a/assets/images/tool-icons/buttondown.png b/assets/images/tool-icons/buttondown.png new file mode 100644 index 000000000..1e791e14c Binary files /dev/null and b/assets/images/tool-icons/buttondown.png differ diff --git a/assets/images/tool-icons/markdown-space.png b/assets/images/tool-icons/markdown-space.png new file mode 100644 index 000000000..4a1f23de3 Binary files /dev/null and b/assets/images/tool-icons/markdown-space.png differ diff --git a/assets/images/tool-icons/mart.png b/assets/images/tool-icons/mart.png new file mode 100644 index 000000000..aa6704e13 Binary files /dev/null and b/assets/images/tool-icons/mart.png differ diff --git a/assets/images/tool-icons/teedoc.png b/assets/images/tool-icons/teedoc.png new file mode 100644 index 000000000..181d312f9 Binary files /dev/null and b/assets/images/tool-icons/teedoc.png differ diff --git a/assets/images/tool-icons/typemill.png b/assets/images/tool-icons/typemill.png new file mode 100644 index 000000000..745a12d90 Binary files /dev/null and b/assets/images/tool-icons/typemill.png differ diff --git a/assets/images/tool-icons/wikibonsai.png b/assets/images/tool-icons/wikibonsai.png new file mode 100644 index 000000000..bfd13819b Binary files /dev/null and b/assets/images/tool-icons/wikibonsai.png differ diff --git a/assets/images/tool-icons/writerside.png b/assets/images/tool-icons/writerside.png new file mode 100644 index 000000000..24b305831 Binary files /dev/null and b/assets/images/tool-icons/writerside.png differ diff --git a/assets/images/tools/buttondown.png b/assets/images/tools/buttondown.png new file mode 100644 index 000000000..e0dc24bc4 Binary files /dev/null and b/assets/images/tools/buttondown.png differ diff --git a/assets/images/tools/markdown-space.png b/assets/images/tools/markdown-space.png new file mode 100644 index 000000000..10978e014 Binary files /dev/null and b/assets/images/tools/markdown-space.png differ diff --git a/assets/images/tools/mart.png b/assets/images/tools/mart.png new file mode 100644 index 000000000..e0edcf9a9 Binary files /dev/null and b/assets/images/tools/mart.png differ diff --git a/assets/images/tools/teedoc.png b/assets/images/tools/teedoc.png new file mode 100644 index 000000000..20b59667d Binary files /dev/null and b/assets/images/tools/teedoc.png differ diff --git a/assets/images/tools/typemill.gif b/assets/images/tools/typemill.gif new file mode 100644 index 000000000..61798190d Binary files /dev/null and b/assets/images/tools/typemill.gif differ diff --git a/assets/images/tools/wikibonsai-demo.png b/assets/images/tools/wikibonsai-demo.png new file mode 100644 index 000000000..47af0357d Binary files /dev/null and b/assets/images/tools/wikibonsai-demo.png differ diff --git a/basic-syntax.md b/basic-syntax.md index f7aab5737..9563dc7d6 100644 --- a/basic-syntax.md +++ b/basic-syntax.md @@ -2,7 +2,7 @@ layout: default title: Basic Syntax description: The Markdown elements outlined in the original design document. -last_modified_at: 2023-04-22 +last_modified_at: 2025-09-28 --- {% include syntax.html type="basic" syntax-id="overview" %} diff --git a/book.md b/book.md index 95bfc1d27..b7cc3983c 100644 --- a/book.md +++ b/book.md @@ -116,6 +116,11 @@ description: "Learn Markdown in 60 pages. The Markdown Guide book includes every +
+

The perfect book form teaching resource for Markdown — concise, mapping functionality, extensions, and best practices. Not a long read, but if you like documentation in book format (I do), this is the book for Markdown syntax.

+
Federico Lucifredi, Author of AWS System Administration: Best Practices for Sysadmins in the Amazon Cloud, via Goodreads
+
+

If you’re working with Markdown, then do yourself a favour and check out The Markdown Guide... It’s excellent.

@@ -131,11 +136,6 @@ description: "Learn Markdown in 60 pages. The Markdown Guide book includes every
-
-

Well done! This is an incredibly valuable and well-done resource. It does a great job of educating without becoming too overwhelming or too narrowly focused on one application of Markdown.

- -
-

100% satisfaction guaranteed.

If you're not completely satisfied with The Markdown Guide, I'll refund your money, no questions asked.

diff --git a/getting-started.md b/getting-started.md index 9707d3e9a..1c5307a72 100644 --- a/getting-started.md +++ b/getting-started.md @@ -2,7 +2,7 @@ layout: default title: Getting Started description: An overview of Markdown, how it works, and what you can do with it. -last_modified_at: 2022-09-26 +last_modified_at: 2025-06-21 --- {% include_relative _getting-started/what-is-markdown.md %} diff --git a/tools.md b/tools.md index c1cc51c5a..a30b13285 100644 --- a/tools.md +++ b/tools.md @@ -2,7 +2,7 @@ layout: tools title: Tools description: Applications and components that support Markdown. -last_modified_at: 2023-07-02 +last_modified_at: 2025-06-24 ---