docs(project): add initial setup for docs publishing

Merge pull request #892 from showdownjs/documentation-initial-setup
This commit is contained in:
Estevão Soares dos Santos 2022-03-15 20:37:45 +00:00 committed by GitHub
commit f2f30349d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 96 additions and 8 deletions

23
.github/workflows/docs.yml vendored Normal file
View File

@ -0,0 +1,23 @@
name: documentation
on: [push]
jobs:
build_docs:
name: Build documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Trigger external build
env:
TOKEN: ${{ secrets.DOCS_DEPLOY_KEY }}
EVENT: build_docs
OWNER: showdownjs
REPO: showdownjs.github.io
run: |
curl -X POST \
-H "Authorization: token ${TOKEN}" \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/${OWNER}/${REPO}/dispatches \
-d '{ "event_type": "'"${EVENT}"'", "client_payload": { "source": "showdown" } }'

View File

@ -1,9 +1,55 @@
# Index # Showdown documentation
1. Options ![Showdown][sd-logo]
2. Subparsers
3. [Event System](event_system.md) ![Build Status: Linux](https://github.com/showdownjs/showdown/actions/workflows/node.linux.yml/badge.svg)
1. [Introduction](event_system.md#introduction) ![Build Status: Windows](https://github.com/showdownjs/showdown/actions/workflows/node.win.yml/badge.svg)
2. [The Event Object](event_system.md#the-event-object) [![npm version](https://badge.fury.io/js/showdown.svg)](http://badge.fury.io/js/showdown)
3. [Events](event_system.md#events) [![Bower version](https://badge.fury.io/bo/showdown.svg)](http://badge.fury.io/bo/showdown)
4. [Events List](event_system.md#events-list) [![Join the chat at https://gitter.im/showdownjs/showdown](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/showdownjs/showdown?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/tiviesantos)
Showdown is a JavaScript Markdown to HTML converter, based on the original works by John Gruber.
Showdown can be used on the client-side (in the browser) or server-side (with Node.js).
----
## Live demo
<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)
* [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)
## License
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
[xss-wiki]: https://github.com/showdownjs/showdown/wiki/Markdown's-XSS-Vulnerability-(and-how-to-mitigate-it)
[ext-wiki]: https://github.com/showdownjs/showdown/wiki/extensions
[coding-rules]: https://github.com/showdownjs/code-style/blob/master/README.md
[ng-commit-guide]: https://github.com/showdownjs/code-style/blob/master/README.md#commit-message-convention
[boilerplate-repo]: https://github.com/showdownjs/extension-boilerplate

19
mkdocs.yml Normal file
View File

@ -0,0 +1,19 @@
site_name: Showdown documentation
site_description: Showdown is a JavaScript Markdown to HTML converter
theme:
name: material
logo: http://showdownjs.com/apple-touch-icon.png
favicon: http://showdownjs.com/apple-touch-icon.png
icon:
repo: fontawesome/brands/github
palette:
primary: red
accent: cyan
repo_url: https://github.com/showdownjs/showdown
repo_name: showdownjs/showdown
site_dir: public
nav:
- Home: index.md