From 15b159c846633f442164448359605d963b46809f Mon Sep 17 00:00:00 2001 From: Antonio Date: Sun, 20 Mar 2022 16:37:51 +0200 Subject: [PATCH] docs: added installation guide, compatibility and donation pages --- docs/compatibility.md | 21 +++++++++++++ docs/donations.md | 7 +++++ docs/index.md | 16 ++++------ docs/installation.md | 68 +++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 15 +++++++++- 5 files changed, 116 insertions(+), 11 deletions(-) create mode 100644 docs/compatibility.md create mode 100644 docs/donations.md create mode 100644 docs/installation.md diff --git a/docs/compatibility.md b/docs/compatibility.md new file mode 100644 index 0000000..1f7ce1e --- /dev/null +++ b/docs/compatibility.md @@ -0,0 +1,21 @@ +## Browsers + +Showdown has been tested successfully with: + +* Firefox 1.5 and 2.0 +* Chrome 12.0 +* Internet Explorer 6 and 7 +* Safari 2.0.4 +* Opera 8.54 and 9.10 +* Netscape 8.1.2 +* Konqueror 3.5.4 + +Generally, Showdown should work in any browser that supports ECMA 262 3rd Edition (JavaScript 1.5). + +The converter might even work in things that aren't web browsers, like Acrobat. However, no promises. + +## Node.js + +Showdown is intended to work on any supported Node.js version (see the [Node.js releases schedule](https://nodejs.org/en/about/releases/). + +Previous versions may also be supported, but no accomodations are made to ensure this. \ No newline at end of file diff --git a/docs/donations.md b/docs/donations.md new file mode 100644 index 0000000..9245597 --- /dev/null +++ b/docs/donations.md @@ -0,0 +1,7 @@ +ShowdownJS is a **free** library and it will remain **free forever**. + +However, maintaining and improving the library costs time and money. + +If you like our work and find it useful, please donate through [PayPal](https://www.paypal.me/tiviesantos). + +:heart: :pray: Your contributions are greatly appreciated and will help us with the development of this awesome library. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 720d8cc..ef5cab5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,23 +18,22 @@ Showdown can be used on the client-side (in the browser) or server-side (with No -ShowdownJS is a free library and it will remain free forever. However, maintaining and improving the library costs time and money. - -If you like our work and find it useful, please donate through [PayPal](https://www.paypal.me/tiviesantos). - -Your contributions are greatly appreciated and will help us with the development of this awesome library. - ## Who uses Showdown (or a fork) +* [Antmarky](https://github.com/bandantonio/antmarky) * [GoogleCloudPlatform](https://github.com/GoogleCloudPlatform) * [Meteor](https://www.meteor.com/) * [StackExchange](http://stackexchange.com/) - forked as [PageDown](https://code.google.com/p/pagedown/) * [docular](https://github.com/Vertafore/docular) * [md-page](https://github.com/oscarmorrison/md-page) * [QCObjects](https://qcobjects.dev) -* [Antmarky](https://github.com/bandantonio/antmarky) * [and some others](https://www.npmjs.com/browse/depended/showdown) +## Installation + +To install Showdown, follow the instructions from the [Installation guide](installation.md). + + ## License ShowdownJS v 2.0 is release under the MIT version. @@ -42,9 +41,6 @@ ShowdownJS v 2.0 is release under the MIT version. Previous versions are release under BSD. [sd-logo]: https://raw.githubusercontent.com/showdownjs/logo/master/dist/logo.readme.png -[legacy-branch]: https://github.com/showdownjs/showdown/tree/legacy -[releases]: https://github.com/showdownjs/showdown/releases -[changelog]: https://github.com/showdownjs/showdown/blob/master/CHANGELOG.md [wiki]: https://github.com/showdownjs/showdown/wiki [cli-wiki]: https://github.com/showdownjs/showdown/wiki/CLI-tool [definitely-typed]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/showdown diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..6c08b96 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,68 @@ +## Packages + +### npm (server-side) + +``` +npm install showdown +``` + +### Bower + +``` +bower install showdown +``` + +### NuGet + +``` +PM> Install-Package showdownjs +``` + +More information about the package you can find on the [NuGet website](https://www.nuget.org/packages/showdownjs/). + +### Tarball + +You can download the latest tarball directly from [releases][releases]. + +## CDN + +You can also use one of several CDNs available: + +### jsDelivr + +``` +https://cdn.jsdelivr.net/npm/showdown@/dist/showdown.min.js +``` + +[Showndown page on jsDelivr](https://www.jsdelivr.com/package/npm/showdown) + +### cdnjs + +``` +https://cdnjs.cloudflare.com/ajax/libs/showdown//showdown.min.js +``` + +[Showndown page on cdnjs](https://cdnjs.com/libraries/showdown) + +### unpkg + +``` +https://unpkg.com/showdown/dist/showdown.min.js +``` + +[Showndown page on unpkg](https://unpkg.com/browse/showdown@latest/) + +!!! note "" + Replace `` with an actual full length version you're interested in. For example, `2.0.3`. + +## Previous versions + +If you're looking for Showdown prior to version 1.0.0, you can find them in the [legacy branch][legacy-branch]. + +## Changelog + +The full changelog is available [here][changelog]. + +[legacy-branch]: https://github.com/showdownjs/showdown/tree/legacy +[releases]: https://github.com/showdownjs/showdown/releases +[changelog]: https://github.com/showdownjs/showdown/blob/master/CHANGELOG.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 358c1f4..034dc80 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,10 +10,23 @@ theme: palette: primary: red accent: cyan + features: + - navigation.tabs + +markdown_extensions: + - admonition + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg repo_url: https://github.com/showdownjs/showdown repo_name: showdownjs/showdown site_dir: public nav: - - Home: index.md \ No newline at end of file + - Home: + - Introduction: index.md + - Donations: donations.md + - Installation: + - Installation: installation.md + - Compatibility: compatibility.md \ No newline at end of file