docs: added installation guide, compatibility and donation pages

This commit is contained in:
Antonio 2022-03-20 16:37:51 +02:00
parent f2f30349d6
commit 15b159c846
5 changed files with 116 additions and 11 deletions

21
docs/compatibility.md Normal file
View File

@ -0,0 +1,21 @@
## Browsers
Showdown has been tested successfully with:
* <img src="https://img.icons8.com/external-tal-revivo-color-tal-revivo/16/000000/external-firefox-a-free-and-open-source-web-browser-developed-by-the-mozilla-foundation-logo-color-tal-revivo.png"/> Firefox 1.5 and 2.0
* <img src="https://img.icons8.com/color/16/000000/chrome--v1.png"/> Chrome 12.0
* <img src="https://img.icons8.com/color/16/000000/internet-explorer.png"/> Internet Explorer 6 and 7
* <img src="https://img.icons8.com/color/16/000000/safari--v1.png"/> Safari 2.0.4
* <img src="https://img.icons8.com/color/16/000000/opera--v1.png"/> Opera 8.54 and 9.10
* <img src="https://img.icons8.com/color/16/000000/netscape.png"/> Netscape 8.1.2
* <img src="https://www.freepngimg.com/save/69063-konqueror-web-kde-manager-file-linux-browser/16x16"/> Konqueror 3.5.4
Generally, Showdown should work in any browser that supports ECMA 262 3<sup>rd</sup> 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.

7
docs/donations.md Normal file
View File

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

View File

@ -18,23 +18,22 @@ Showdown can be used on the client-side (in the browser) or server-side (with No
<http://demo.showdownjs.com/> <http://demo.showdownjs.com/>
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) ## Who uses Showdown (or a fork)
* [Antmarky](https://github.com/bandantonio/antmarky)
* [GoogleCloudPlatform](https://github.com/GoogleCloudPlatform) * [GoogleCloudPlatform](https://github.com/GoogleCloudPlatform)
* [Meteor](https://www.meteor.com/) * [Meteor](https://www.meteor.com/)
* [StackExchange](http://stackexchange.com/) - forked as [PageDown](https://code.google.com/p/pagedown/) * [StackExchange](http://stackexchange.com/) - forked as [PageDown](https://code.google.com/p/pagedown/)
* [docular](https://github.com/Vertafore/docular) * [docular](https://github.com/Vertafore/docular)
* [md-page](https://github.com/oscarmorrison/md-page) * [md-page](https://github.com/oscarmorrison/md-page)
* [QCObjects](https://qcobjects.dev) * [QCObjects](https://qcobjects.dev)
* [Antmarky](https://github.com/bandantonio/antmarky)
* [and some others](https://www.npmjs.com/browse/depended/showdown) * [and some others](https://www.npmjs.com/browse/depended/showdown)
## Installation
To install Showdown, follow the instructions from the [Installation guide](installation.md).
## License ## License
ShowdownJS v 2.0 is release under the MIT version. 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. Previous versions are release under BSD.
[sd-logo]: https://raw.githubusercontent.com/showdownjs/logo/master/dist/logo.readme.png [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 [wiki]: https://github.com/showdownjs/showdown/wiki
[cli-wiki]: https://github.com/showdownjs/showdown/wiki/CLI-tool [cli-wiki]: https://github.com/showdownjs/showdown/wiki/CLI-tool
[definitely-typed]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/showdown [definitely-typed]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/showdown

68
docs/installation.md Normal file
View File

@ -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@<version>/dist/showdown.min.js
```
[Showndown page on jsDelivr](https://www.jsdelivr.com/package/npm/showdown)
### cdnjs
```
https://cdnjs.cloudflare.com/ajax/libs/showdown/<version>/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 `<version>` 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

View File

@ -10,10 +10,23 @@ theme:
palette: palette:
primary: red primary: red
accent: cyan 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_url: https://github.com/showdownjs/showdown
repo_name: showdownjs/showdown repo_name: showdownjs/showdown
site_dir: public site_dir: public
nav: nav:
- Home: index.md - Home:
- Introduction: index.md
- Donations: donations.md
- Installation:
- Installation: installation.md
- Compatibility: compatibility.md