Skip to content

Commit 3162ce2

Browse files
committed
Update readme
1 parent a3ec589 commit 3162ce2

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

.vscode/settings.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,9 @@
55
},
66
"cSpell.words": [
77
"callouts"
8-
]
8+
],
9+
"workbench.colorCustomizations": {
10+
"statusBar.noFolderBackground": "#49d6a0",
11+
"statussBar.prominentBackground": "#49d6a0"
12+
}
913
}

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
notion-pull lets you use Notion as your editor for markdown-based static site generators like [Docusaurus](https://docusaurus.io/). Using Notion instead of raw markdown files means that you don't have to teach non-developers how to make git commits and pull requests. It also allows you to leverage Notion's database tools to control workflow, Notion's commenting feature to discuss changes, etc.
44

5-
Note that notion-pull is not a service that could be reading your data. `node-pull` is just open-source code that will run on your computer or your continuous integration system.
5+
Example Site: https://sillsdev.github.io/notion-pull-sample-site/
6+
7+
# Instructions
68

79
## 1. Set up your documentation site.
810

9-
First, prepare your markdown-based static file system like [Docusaurus](https://docusaurus.io/).
11+
First, prepare your markdown-based static file system like [Docusaurus](https://docusaurus.io/). For a shortcut with github actions, search, and deployment to github pages, you can just copy [this template](https://github.com/sillsdev/notion-pull-sample-site).
1012

1113
## 2. In Notion, duplicate the notion-pull template
1214

0 commit comments

Comments
 (0)