From b967b222b1bb6dfb1e91e8a444226ae690d4a450 Mon Sep 17 00:00:00 2001
From: Matthew Dillon <matthewrdillon@gmail.com>
Date: Sat, 17 Oct 2020 19:25:16 -0700
Subject: [PATCH] Initial commit

---
 .gitattributes                 |  3 +++
 .github/workflows/publish.yaml | 27 +++++++++++++++++++++++++++
 .gitignore                     |  1 +
 .nojekyll                      |  1 +
 .vscode/extensions.json        | 30 ++++++++++++++++++++++++++++++
 .vscode/settings.json          | 23 +++++++++++++++++++++++
 README.md                      | 32 ++++++++++++++++++++++++++++++++
 faq.md                         | 19 +++++++++++++++++++
 index.md                       | 13 +++++++++++++
 neuron.dhall                   |  8 ++++++++
 static/README.md               |  1 +
 11 files changed, 158 insertions(+)
 create mode 100644 .gitattributes
 create mode 100644 .github/workflows/publish.yaml
 create mode 100644 .gitignore
 create mode 100644 .nojekyll
 create mode 100644 .vscode/extensions.json
 create mode 100644 .vscode/settings.json
 create mode 100644 README.md
 create mode 100644 faq.md
 create mode 100644 index.md
 create mode 100644 neuron.dhall
 create mode 100644 static/README.md

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..e418ba8
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,3 @@
+*.md linguist-detectable
+*.md linguist-language=Markdown
+*.md linguist-documentation=false
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
new file mode 100644
index 0000000..b618c58
--- /dev/null
+++ b/.github/workflows/publish.yaml
@@ -0,0 +1,27 @@
+name: "Publish"
+on:
+  # Run only when pushing to master branch
+  push:
+    branches:
+      - master
+jobs:
+  neuron:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Download neuron
+      run: |
+        curl --silent https://api.github.com/repos/srid/neuron/actions/artifacts \
+          | jq 'first(.artifacts | .[] | select(.name == "neuron-bundle-linux") | .archive_download_url)' -r \
+          | xargs curl -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" --silent -L -o neuron-bundle-linux.zip
+        unzip neuron-bundle-linux.zip
+        chmod +x neuron
+        ./neuron --version  # This extracts the bundle; should take a while
+    - name: Build neuron site 🔧
+      run: |
+        ./neuron -d $PWD rib
+    - name: Deploy to gh-pages 🚀
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: .neuron/output/
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..c8392ad
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.neuron
diff --git a/.nojekyll b/.nojekyll
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/.nojekyll
@@ -0,0 +1 @@
+
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644
index 0000000..c15387a
--- /dev/null
+++ b/.vscode/extensions.json
@@ -0,0 +1,30 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		// Main markdown support
+		"yzhang.markdown-all-in-one",
+
+		// Zettelkasten wiki-links, backlinks, etc.
+		"svsool.markdown-memo",
+
+		// Graph view 
+		// Disabled until https://github.com/tchayen/markdown-links/issues/28 is done
+		// "tchayen.markdown-links",
+
+		// For expanding title in daily note
+		"gruntfuggly.auto-snippet",
+
+		// Commands for bold, italic, etc.
+		"mdickin.markdown-shortcuts",
+
+		// Goodies:
+		// - Checkboxes
+		"bierner.markdown-checkbox",
+		// - Footnote
+		"houkanshan.vscode-markdown-footnote",
+		
+		// Language - spell checker
+		"streetsidesoftware.code-spell-checker"
+	]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..5519e72
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,23 @@
+{
+    // Avoid having to explicitly save notes
+    "files.autoSave": "afterDelay",
+    
+    // Minimap is not useful for Markdown notes
+    "editor.minimap.enabled": false,
+    
+    // Generally note files are not opened in duplicate tabs.
+    // This also enables you to navigate to already open note in other split pane
+    "workbench.editor.revealIfOpen": true,
+    
+    // For those that use daily notes, via vscode-memo extension
+    "autoSnippet.snippets": [
+        {
+            "pattern": "**/\\d{4}-\\d{2}-\\d{2}.md",
+            "snippet": "daily"
+        }
+    ]
+    
+    // If use Git, these might be interesting:
+    // "git.autofetch": true,
+    // "git.postCommitCommand": "push"
+}
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..68823f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# How to publish your own [neuron] site
+
+[neuron] is a note-taking app optimized for publishing, and you can use this template repository to get started with [publishing](https://neuron.zettel.page/778816d3.html) your own neuron site that looks like [one of these][examples].
+
+- Go to <https://github.com/srid/neuron-template/generate>
+- Give your new repository a name, say `mynotes`
+- Select "*Include all branches*" ([necessary to get the site to publish](https://stackoverflow.com/a/47368231/55246))
+- Click "Create repository from template"
+  - Note: if you are on the free GitHub plan, your repository should be public for GitHub to publish it.
+
+GitHub will now build the site and serve it at: `https://<yourgithubusername>.github.io/mynotes/`.
+
+For more information, see [neuron documentation][neuron] as well as the [GitHub Pages guide](https://help.github.com/en/github/working-with-github-pages).
+
+## Set your site metadata
+
+- In your new repository, edit the `neuron.dhall` file to set your site configuration (such as title, author, color theme) to suitable values.
+
+## How to edit and add notes
+
+Assuming you have changed the `editUrl` configuration in `neuron.dhall` (see the above section), you can simply click the "edit" icon on the published site to edit any note (see [Editing files in your repository](https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-your-repository) and [Creating new files](https://help.github.com/en/github/managing-files-in-a-repository/creating-new-files)). On every change, your site should eventually rebuild.
+
+To understand how linking works, read [the neuron guide on Linking][linking].
+
+For other ways to edit your notes (editors, web interface), see the [neuron guide][create]. In particular, [Cerveau](https://www.cerveau.app/) is the easiest way to edit your notes on the go.
+
+Questions? Checkout the [[faq]].
+
+[neuron]: https://neuron.zettel.page/
+[examples]: https://neuron.zettel.page/examples.html
+[linking]: https://neuron.zettel.page/linking.html
+[create]: https://neuron.zettel.page/create.html
\ No newline at end of file
diff --git a/faq.md b/faq.md
new file mode 100644
index 0000000..c6314c5
--- /dev/null
+++ b/faq.md
@@ -0,0 +1,19 @@
+---
+tags: [other]
+---
+
+# FAQ
+
+How long does it take for the site to update?
+:  The [GitHub Actions](https://github.com/features/actions) build itself takes about ~25 seconds to run. It is generally expected for your site to update around that duration, and take no more than a minute.
+
+Which environment is used to build and deploy the site?
+: From the [Actions workflow file](https://github.com/srid/neuron-template/blob/master/.github/workflows/publish.yaml), it can be seen that we install [neuron](https://neuron.zettel.page/) using GitHub's artifact storage in Srid's repo [srid/neuron](https://github.com/srid/neuron), as well as use the  [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) action to push the built site to the `gh-pages` branch, that in turn gets deployed to GitHub's servers.
+
+Can I use my own domain name?
+: Yes, you can [set the CNAME in publish.yaml][cname].
+
+How can private repositories be published?
+: You will need a GitHub paid plan to publish private repositories. Public repositories on the other hand can be published in the GitHub free plan. [Cerveau](https://www.cerveau.app/)'s Premium Plan, when it is ready, will be able to publish public and private repositories.
+
+[cname]: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-add-cname-file-cname
\ No newline at end of file
diff --git a/index.md b/index.md
new file mode 100644
index 0000000..84d2be9
--- /dev/null
+++ b/index.md
@@ -0,0 +1,13 @@
+---
+tags: [home]
+---
+
+# Neuron Template
+
+You are viewing a template site, generated from [neuron-template](https://github.com/srid/neuron-template) and published by [neuron](https://neuron.zettel.page/). [GitHub Pages](https://pages.github.com/) is used to automatically publish this site every time the underlying Git repository gets updated.
+
+Get started by reading [[[README]]].
+
+Other pages on this zettelkasten (this demonstrates how to use [link queries](https://neuron.zettel.page/link-query.html)):
+
+[[[z:zettels?tag=other]]]
diff --git a/neuron.dhall b/neuron.dhall
new file mode 100644
index 0000000..be7ac4c
--- /dev/null
+++ b/neuron.dhall
@@ -0,0 +1,8 @@
+{ siteTitle = "Neuron Template"
+, author = Some "John Doe"
+, siteBaseUrl = Some "https://srid.github.io/neuron-template"
+-- List of theme colors: https://neuron.zettel.page/2014601.html
+, theme = "teal"
+-- This is used in the "edit" button
+, editUrl = Some "https://github.com/srid/neuron-template/edit/master/"
+}
diff --git a/static/README.md b/static/README.md
new file mode 100644
index 0000000..a594aee
--- /dev/null
+++ b/static/README.md
@@ -0,0 +1 @@
+Put your [static files](https://neuron.zettel.page/2016401.html) (images, pdf, etc.) here.