This repository has been archived by the owner on Apr 21, 2019. It is now read-only.
forked from notion-cli/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 03e817a
Showing
25 changed files
with
508 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
_site | ||
.sass-cache | ||
.jekyll-metadata |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
layout: default | ||
--- | ||
|
||
<style type="text/css" media="screen"> | ||
.container { | ||
margin: 10px auto; | ||
max-width: 600px; | ||
text-align: center; | ||
} | ||
h1 { | ||
margin: 30px 0; | ||
font-size: 4em; | ||
line-height: 1; | ||
letter-spacing: -1px; | ||
} | ||
</style> | ||
|
||
<div class="container"> | ||
<h1>404</h1> | ||
|
||
<p><strong>Page not found :(</strong></p> | ||
<p>The requested page could not be found.</p> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
source "https://rubygems.org" | ||
|
||
# Hello! This is where you manage which Jekyll version is used to run. | ||
# When you want to use a different version, change it below, save the | ||
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: | ||
# | ||
# bundle exec jekyll serve | ||
# | ||
# This will help ensure the proper Jekyll version is running. | ||
# Happy Jekylling! | ||
gem "jekyll", "~> 3.8.5" | ||
|
||
gem "notion-jekyll-theme", :git => "https://github.com/notion-cli/jekyll-theme" | ||
|
||
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and | ||
# uncomment the line below. To upgrade, run `bundle update github-pages`. | ||
# gem "github-pages", group: :jekyll_plugins | ||
|
||
# If you have any plugins, put them here! | ||
group :jekyll_plugins do | ||
gem "jekyll-feed", "~> 0.6" | ||
end | ||
|
||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem | ||
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] | ||
|
||
# Performance-booster for watching directories on Windows | ||
gem "wdm", "~> 0.1.0" if Gem.win_platform? | ||
|
||
|
||
gem "nokogiri", "~> 1.10" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
GIT | ||
remote: https://github.com/notion-cli/jekyll-theme | ||
revision: 1855ab1a5178608ade9ddd55b8665b6e1f3c5c7e | ||
specs: | ||
notion-jekyll-theme (0.1.0) | ||
jekyll (~> 3.8) | ||
|
||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
addressable (2.5.2) | ||
public_suffix (>= 2.0.2, < 4.0) | ||
colorator (1.1.0) | ||
concurrent-ruby (1.1.4) | ||
em-websocket (0.5.1) | ||
eventmachine (>= 0.12.9) | ||
http_parser.rb (~> 0.6.0) | ||
eventmachine (1.2.7) | ||
ffi (1.10.0) | ||
forwardable-extended (2.6.0) | ||
http_parser.rb (0.6.0) | ||
i18n (0.9.5) | ||
concurrent-ruby (~> 1.0) | ||
jekyll (3.8.5) | ||
addressable (~> 2.4) | ||
colorator (~> 1.0) | ||
em-websocket (~> 0.5) | ||
i18n (~> 0.7) | ||
jekyll-sass-converter (~> 1.0) | ||
jekyll-watch (~> 2.0) | ||
kramdown (~> 1.14) | ||
liquid (~> 4.0) | ||
mercenary (~> 0.3.3) | ||
pathutil (~> 0.9) | ||
rouge (>= 1.7, < 4) | ||
safe_yaml (~> 1.0) | ||
jekyll-feed (0.11.0) | ||
jekyll (~> 3.3) | ||
jekyll-sass-converter (1.5.2) | ||
sass (~> 3.4) | ||
jekyll-watch (2.1.2) | ||
listen (~> 3.0) | ||
kramdown (1.17.0) | ||
liquid (4.0.1) | ||
listen (3.1.5) | ||
rb-fsevent (~> 0.9, >= 0.9.4) | ||
rb-inotify (~> 0.9, >= 0.9.7) | ||
ruby_dep (~> 1.2) | ||
mercenary (0.3.6) | ||
mini_portile2 (2.4.0) | ||
nokogiri (1.10.0) | ||
mini_portile2 (~> 2.4.0) | ||
pathutil (0.16.2) | ||
forwardable-extended (~> 2.6) | ||
public_suffix (3.0.3) | ||
rb-fsevent (0.10.3) | ||
rb-inotify (0.10.0) | ||
ffi (~> 1.0) | ||
rouge (3.3.0) | ||
ruby_dep (1.5.0) | ||
safe_yaml (1.0.4) | ||
sass (3.7.3) | ||
sass-listen (~> 4.0.0) | ||
sass-listen (4.0.0) | ||
rb-fsevent (~> 0.9, >= 0.9.4) | ||
rb-inotify (~> 0.9, >= 0.9.7) | ||
|
||
PLATFORMS | ||
ruby | ||
|
||
DEPENDENCIES | ||
jekyll (~> 3.8.5) | ||
jekyll-feed (~> 0.6) | ||
nokogiri (~> 1.10) | ||
notion-jekyll-theme! | ||
tzinfo-data | ||
|
||
BUNDLED WITH | ||
1.16.4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Hooks | ||
--- | ||
|
||
# Hooks | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Advanced Usage | ||
--- | ||
|
||
# Advanced Usage | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Welcome to Jekyll! | ||
# | ||
# This config file is meant for settings that affect your whole blog, values | ||
# which you are expected to set up once and rarely edit after that. If you find | ||
# yourself editing this file very often, consider using Jekyll's data files | ||
# feature for the data you need to update frequently. | ||
# | ||
# For technical reasons, this file is *NOT* reloaded automatically when you use | ||
# 'bundle exec jekyll serve'. If you change this file, please restart the server process. | ||
|
||
# Site settings | ||
# These are used to personalize your new site. If you look in the HTML files, | ||
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. | ||
# You can create any custom variable you would like, and they will be accessible | ||
# in the templates via {{ site.myvariable }}. | ||
title: Notion - Docs | ||
email: [email protected] | ||
description: >- # this means to ignore newlines until "baseurl:" | ||
Write an awesome description for your new site here. You can edit this | ||
line in _config.yml. It will appear in your document head meta (for | ||
Google search results) and in your feed.xml site description. | ||
baseurl: "" # the subpath of your site, e.g. /blog | ||
url: "" # the base hostname & protocol for your site, e.g. http://example.com | ||
twitter_username: jekyllrb | ||
github_username: jekyll | ||
|
||
collections: | ||
guide: | ||
output: true | ||
permalink: /guide/:name | ||
reference: | ||
output: true | ||
permalink: /reference/:name | ||
advanced: | ||
output: true | ||
permalink: /advanced/:name | ||
contributing: | ||
output: true | ||
permalink: /contributing/:name | ||
|
||
defaults: | ||
- scope: | ||
path: "" | ||
values: | ||
layout: doc | ||
|
||
# Build settings | ||
markdown: kramdown | ||
theme: notion-jekyll-theme | ||
plugins: | ||
- jekyll-feed | ||
|
||
# Exclude from processing. | ||
# The following items will not be processed, by default. Create a custom list | ||
# to override the default setting. | ||
# exclude: | ||
# - Gemfile | ||
# - Gemfile.lock | ||
# - node_modules | ||
# - vendor/bundle/ | ||
# - vendor/cache/ | ||
# - vendor/gems/ | ||
# - vendor/ruby/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Contributing Guide | ||
--- | ||
|
||
# Contributing Guide |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
track: docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
- id: guide | ||
url: /guide/ | ||
title: Guide | ||
docs: | ||
- id: index | ||
url: /guide/ | ||
title: Introduction | ||
sub-headers: | ||
- id: features | ||
title: Features | ||
- id: why-notion | ||
title: Why Notion? | ||
- id: how-does-it-work | ||
title: How does it work? | ||
- id: getting-started | ||
url: /guide/getting-started/ | ||
title: Getting Started | ||
- id: understanding | ||
url: /guide/understanding/ | ||
title: Understanding Notion | ||
sub-headers: | ||
- id: tools-and-toolchains | ||
title: Tools and Toolchains | ||
- id: user-toolchain | ||
title: User Toolchain | ||
- id: project-toolchains | ||
title: Project Toolchains | ||
- id: reference | ||
url: /reference/ | ||
title: Reference | ||
docs: | ||
- id: index | ||
url: /reference/ | ||
title: Notion Commands | ||
- id: fetch | ||
url: /reference/fetch/ | ||
title: notion fetch | ||
- id: install | ||
url: /reference/install/ | ||
title: notion install | ||
- id: pin | ||
url: /reference/pin/ | ||
title: notion pin | ||
- id: current | ||
url: /reference/current/ | ||
title: notion current | ||
- id: deactivate | ||
url: /reference/deactivate/ | ||
title: notion deactivate | ||
- id: activate | ||
url: /reference/activate/ | ||
title: notion activate | ||
- id: help | ||
url: /reference/help/ | ||
title: notion help | ||
- id: version | ||
url: /reference/version/ | ||
title: notion version | ||
- id: advanced | ||
url: /advanced/ | ||
title: Advanced | ||
docs: | ||
- id: index | ||
url: /advanced/ | ||
title: Advanced Usage | ||
- id: hooks | ||
url: /advanced/hooks/ | ||
title: Hooks | ||
- id: contributing | ||
url: /contributing/ | ||
title: Contributing | ||
docs: | ||
- id: index | ||
url: /contributing/ | ||
title: Contributing Guide | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Getting Started | ||
--- | ||
|
||
# Getting Started | ||
|
||
## Unix Installation | ||
|
||
On most Unix systems, you can install Notion with a single command: | ||
|
||
```bash | ||
curl -sSLf https://get.notionjs.com | bash | ||
``` | ||
|
||
For [bash](https://www.gnu.org/software/bash/), this installer will automatically update your console startup script. | ||
|
||
To configure other shells to use Notion, edit your console startup scripts to: | ||
- Set the `NOTION_HOME` variable to `~/.notion` | ||
- Add `$NOTION_HOME/bin` to the beginning of your `PATH` variable | ||
|
||
## Windows Installation | ||
|
||
::: warning | ||
A Windows installer is in development. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: Introduction | ||
--- | ||
|
||
# Introduction | ||
|
||
Welcome to Notion! | ||
|
||
Notion is a hassle-free way to manage your JavaScript command-line tools. | ||
|
||
## Features | ||
|
||
- Speed 🚀 | ||
- Seamless, per-project version switching | ||
- Cross-platform support, including Windows and all Unix shells | ||
- Support for multiple package managers | ||
- Stable tool installation—no reinstalling on every Node upgrade! | ||
- Extensibility hooks for site-specific customization | ||
|
||
|
||
## Why Notion? | ||
|
||
## How does it work? | ||
|
Oops, something went wrong.