Merge pull request #356 from automatisch/docs/typeform-connection-guide
docs: Add guide for typeform connection setup
This commit is contained in:
@@ -4,52 +4,11 @@ sidebar_position: 5
|
|||||||
|
|
||||||
# Typeform
|
# Typeform
|
||||||
|
|
||||||
Docusaurus can manage multiple versions of your docs.
|
1. Go to the [link](https://admin.typeform.com/user) and click on **Developer apps** in the sidebar.
|
||||||
|
2. Click on the "Register a new app" button.
|
||||||
## Create a docs version
|
3. Fill **App name** and **App website**, and **Developer email** fields.
|
||||||
|
4. Copy **OAuth Redirect URL** from Automatisch to **Redirect URI(s)** field on the Typeform page.
|
||||||
Release a version 1.0 of your project:
|
5. Click on the **Register app** button.
|
||||||
|
6. Copy **Client ID** and **Client Secret** values from Typeform to Automatisch.
|
||||||
```bash
|
7. Click **Submit** button on Automatisch.
|
||||||
npm run docusaurus docs:version 1.0
|
8. Congrats! Typeform connection is created.
|
||||||
```
|
|
||||||
|
|
||||||
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
|
||||||
|
|
||||||
Your docs now have 2 versions:
|
|
||||||
|
|
||||||
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
|
||||||
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
|
||||||
|
|
||||||
## Add a Version Dropdown
|
|
||||||
|
|
||||||
To navigate seamlessly across versions, add a version dropdown.
|
|
||||||
|
|
||||||
Modify the `docusaurus.config.js` file:
|
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
|
||||||
module.exports = {
|
|
||||||
themeConfig: {
|
|
||||||
navbar: {
|
|
||||||
items: [
|
|
||||||
// highlight-start
|
|
||||||
{
|
|
||||||
type: 'docsVersionDropdown',
|
|
||||||
},
|
|
||||||
// highlight-end
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
The docs version dropdown appears in your navbar:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Update an existing version
|
|
||||||
|
|
||||||
It is possible to edit versioned docs in their respective folder:
|
|
||||||
|
|
||||||
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
|
||||||
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
|
||||||
|
Reference in New Issue
Block a user