ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add table of content support

Browse Source
This commit is contained in:
Hans Pagel
2020-09-27 10:29:01 +02:00
parent bcef08ce2a
commit 149ce56ad8
18 changed files with 66 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/docPages/overview/contributing.md
View File

@@ -1,20 +1,18 @@
# Contributing
Tiptap would be nothing without its lively community. Contributions have always been and will always be welcome. Here is a little bit you should know, before you send your contribution:
## Examples
## Table of Contents
## Examples
* Improved documentation, e. g. fixing typos, new sections, further explanation …)
* New features for existing extensions, e. g. a new option
* New extensions, which don’t require changes to the core or other core extensions
* Well explained, non-breaking changes to the core
## Code style
There is a eslint config, that ensures a consistent code style. To check for errors, run `$ yarn run lint`. That’ll be checked when you send a pull request. Make sure it’s passing, before sending a pull request.
## Testing
All your pull requests will automatically run all our existing tests. Make sure that they all pass. Run all tests locally with `$ yarn run test` or run single tests (e. g. when writing new ones) with `$ yarn run test:open`.
Any further questions? Create a new issue or discussion in the repository. We’ll get back to you.

4
docs/src/docPages/overview/installation.md
View File

@@ -1,6 +1,8 @@
# Installation
You’re free to use tiptap with the framework of your choice. Depending on what you want to do, there are a few different ways to install tiptap in your project. Choose the way that fits your workflow.
## Table of Contents
## Option 1: Vanilla JavaScript
Use tiptap with vanilla JavaScript for a very lightweight and raw experience. If you feel like it, you can even use it to connect tiptap with other frameworks not mentioned here.
@@ -49,7 +51,7 @@ yarn add @tiptap/core @tiptap/vue @tiptap/vue-starter-kit
Create a new component and add the following content to get a basic version of tiptap:
<demo name="General/Installation" />
<demo name="Overview/Installation" />
<!-- ## Option 3: CodeSandbox

2
docs/src/docPages/overview/upgrade-guide.md
View File

@@ -1,5 +1,7 @@
# Upgrade Guide
## Table of Contents
## Reasons to upgrade to tiptap 2.x
Yes, it’s tedious work to upgrade your favorite text editor to a new API, but we made sure you’ve got enough reasons to upgrade to the newest version