Skip to content

Commit

Permalink
Refactoring docs and sidebar
Browse files Browse the repository at this point in the history
kiwicopple committed Dec 4, 2019
1 parent dd6c96b commit 2f5ad78
Showing 19 changed files with 394 additions and 45 deletions.
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": false,
"singleQuote": true,
"printWidth": 100
}
File renamed without changes.
7 changes: 7 additions & 0 deletions docs/api/authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
id: authentication
title: Authentication
---


Auth headers
2 changes: 1 addition & 1 deletion docs/api-expo.md → docs/api/expo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-expo
id: expo
title: Expo
---

2 changes: 1 addition & 1 deletion docs/api-facebook.md → docs/api/facebook.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-facebook
id: facebook
title: Facebook
---

Original file line number Diff line number Diff line change
@@ -3,4 +3,8 @@ id: getting-started
title: Getting Started
---

Flock is still in Alpha. We are building the documentation and will release be accepting beta testers soon.
Flock is still in Alpha. We are building the documentation and will release be accepting beta testers soon.

```sh
https://api.flock.rest
```
2 changes: 1 addition & 1 deletion docs/api-mailgun.md → docs/api/mailgun.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-mailgun
id: mailgun
title: Mailgun
---

2 changes: 1 addition & 1 deletion docs/api-nexmo.md → docs/api/nexmo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-nexmo
id: nexmo
title: Nexmo
---

2 changes: 1 addition & 1 deletion docs/api-slack.md → docs/api/slack.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-slack
id: slack
title: Slack
---

12 changes: 12 additions & 0 deletions docs/api/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: testing
title: Testing
---


Change the URL to from "flock.rest" to "flock.sh"


```sh
https://api.flock.sh
```
2 changes: 1 addition & 1 deletion docs/api-twilio.md → docs/api/twilio.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-twilio
id: twilio
title: Twilio
---

7 changes: 0 additions & 7 deletions docs/intro-testing.md

This file was deleted.

8 changes: 5 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -15,14 +15,16 @@ module.exports = {
projectName: "flock", // Usually your repo name.
themeConfig: {
navbar: {
style: "dark",
title: "flock",
// logo: {
// alt: "Flock",
// src: "img/logo.svg"
// src: "img/logo.svg",
// darkSrc: 'img/logo-dark.svg'
// },
links: [
{ to: "docs/about", label: "Docs", position: "right" },l
{ to: "guides", label: "Guides", position: "right" },
{ to: "docs/about", label: "Docs", position: "right" },
{ to: "blog", label: "Guides", position: "right" },
{
href: "https://github.com/pollygot/flock",
label: "GitHub",
15 changes: 15 additions & 0 deletions guides/2019-05-30-welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: welcome
title: Welcome
author: Yangshun Tay
author_title: Front End Engineer @ Facebook
author_url: https://github.com/yangshun
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4
tags: [facebook, hello, docusaurus]
---

<!--truncate-->

Blog features are powered by the blog plugin. Simple add files to the `blog` directory. It supports tags as well!

Delete the whole directory if you don't want the blog features. As simple as that!
61 changes: 44 additions & 17 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2f5ad78

Please sign in to comment.