Commit 7f99e4f95e0e5319aa7c779f4329858d3a83cf6d
initial!!
mixmix committed on 11/15/2018, 11:05:17 AMFiles changed
SUMMARY.md | ||
---|---|---|
@@ -1,0 +1,19 @@ | ||
1 … | +# Summary | |
2 … | + | |
3 … | +* [Introduction](README.md) | |
4 … | + | |
5 … | +* [Scuttlebot](scuttlebot/index.md) | |
6 … | + * [scuttlebot](scuttlebot/scuttlebot.md) (meh) | |
7 … | + | |
8 … | +* [Scuttlebot Plugins](plugins/index.md) | |
9 … | + * [ssb-about](./plugins/ssb-about.md) | |
10 … | + * [ssb-backlinks](./plugins/ssb-backlinks.md) | |
11 … | + | |
12 … | +* [**Schemas**](schemas/index.md) | |
13 … | + * [ssb-invite-schema](./schemas/ssb-invite-schema.md) | |
14 … | + * [ssb-gathering-schema](./schemas/ssb-gathering-schema.md) | |
15 … | + * [ssb-dark-crystal-schema](./schemas/ssb-dark-crystal-schema.md) | |
16 … | + * [ssb-msg-schemas\*](./schemas/ssb-msg-schema.md) | |
17 … | + * [ssb-poll-schema](./schemas/ssb-poll-schema.md) | |
18 … | + * [ssb-schema-definitions\*](./schemas/ssb-schema-definitions.md) | |
19 … | + * [ssb-schema-validation\*](./schemas/ssb-schema-validation.md) |
book.json | ||
---|---|---|
@@ -1,0 +1,18 @@ | ||
1 … | +{ | |
2 … | + "title": "scuttle-docs", | |
3 … | + "author": "mixmix", | |
4 … | + "gitbook": "^3.2.3", | |
5 … | + "plugins": [ | |
6 … | + "theme-code", | |
7 … | + "splitter", | |
8 … | + "prism", | |
9 … | + "folding-menu", | |
10 … | + "-sharing", | |
11 … | + "-highlight" | |
12 … | + ], | |
13 … | + "pluginsConfig": { | |
14 … | + "theme-default": { | |
15 … | + "showLevel": false | |
16 … | + } | |
17 … | + } | |
18 … | +} |
package-lock.json | ||
---|---|---|
@@ -1,0 +1,14 @@ | ||
1 … | +{ | |
2 … | + "name": "scuttlebutt-docs", | |
3 … | + "version": "1.0.0", | |
4 … | + "lockfileVersion": 1, | |
5 … | + "requires": true, | |
6 … | + "dependencies": { | |
7 … | + "gitbook-plugin-folding-menu": { | |
8 … | + "version": "1.0.1", | |
9 … | + "resolved": "https://registry.npmjs.org/gitbook-plugin-folding-menu/-/gitbook-plugin-folding-menu-1.0.1.tgz", | |
10 … | + "integrity": "sha512-v4DYQuirkRdC5VvOgNcmHaR56NlllFmli5b82tbmWmLg4j99EUsVrsuc/Z5GEwolkShGZ892uPzqLQ+UmeKxpw==", | |
11 … | + "dev": true | |
12 … | + } | |
13 … | + } | |
14 … | +} |
package.json | ||
---|---|---|
@@ -1,0 +1,28 @@ | ||
1 … | +{ | |
2 … | + "name": "scuttlebutt-docs", | |
3 … | + "version": "1.0.0", | |
4 … | + "description": "", | |
5 … | + "main": "SUMMARY.md", | |
6 … | + "scripts": { | |
7 … | + "postinstall": "gitbook install", | |
8 … | + "start": "gitbook serve" | |
9 … | + }, | |
10 … | + "repository": { | |
11 … | + "type": "git", | |
12 … | + "url": "git+https://github.com/ssbc/scuttlebutt-docs.git" | |
13 … | + }, | |
14 … | + "homepage": "https://github.com/ssbc/scuttlebutt-docs#readme", | |
15 … | + "keywords": [ | |
16 … | + "ssb", | |
17 … | + "scuttlebutt", | |
18 … | + "ecosystem", | |
19 … | + "docs" | |
20 … | + ], | |
21 … | + "author": "mixmix", | |
22 … | + "license": "AGPL-3.0", | |
23 … | + "bugs": { | |
24 … | + "url": "https://github.com/ssbc/scuttlebutt-docs/issues" | |
25 … | + }, | |
26 … | + "dependencies": {}, | |
27 … | + "devDependencies": {} | |
28 … | +} |
plugins/index.md |
---|
plugins/ssb-about.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/ssbc/ssb-about.git/README.md" %} |
plugins/ssb-backlinks.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/ssbc/ssb-backlinks.git/README.md" %} |
schemas/index.md | ||
---|---|---|
@@ -1,0 +1,7 @@ | ||
1 … | +# Schemas | |
2 … | + | |
3 … | +We use JSON-schemas to specify the shape of messages. | |
4 … | + | |
5 … | +Most of these modules use `is-my-json-valid` to convert these schemas into validators. | |
6 … | + | |
7 … | +This is useful when it comes to filtering messages you're reading out of the database for valid fields, as well as checking the form of messages you're about to publish. |
schemas/ssb-dark-crystal-schema.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/blockades/ssb-dark-crystal-schema.git/README.md" %} |
schemas/ssb-gathering-schema.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/ssbc/ssb-gathering-schema.git/README.md" %} |
schemas/ssb-invite-schema.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/ssbc/ssb-invite-schema.git/README.md" %} |
schemas/ssb-msg-schemas.md | ||
---|---|---|
@@ -1,0 +1,5 @@ | ||
1 … | +> this is an earlier module and not used that much | |
2 … | + | |
3 … | +--- | |
4 … | + | |
5 … | +{% include "git+https://github.com/ssbc/ssb-msg-schemas.git/README.md" %} |
schemas/ssb-poll-schema.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/ssbc/ssb-poll-schema.git/README.md" %} |
schemas/ssb-schema-definitions.md | ||
---|---|---|
@@ -1,0 +1,1 @@ | ||
1 … | +{% include "git+https://github.com/ssbc/ssb-schema-definitions.git/README.md" %} |
Built with git-ssb-web