Skip to content
Permalink
Browse files

Adds more docs

  • Loading branch information...
abhin4v committed Jun 8, 2019
1 parent 79117d9 commit 63b46529b54379c2ac188609a1631d13684e5ef4
Showing with 8 additions and 5 deletions.
  1. +1 −1 README.md
  2. +1 −1 _config.yml
  3. +2 −0 demo-note.md
  4. +3 −1 introduction.md
  5. +1 −2 setup.markdown
@@ -1,6 +1,6 @@
# Precis

Precis is a minimal note taking web-app built over Github Pages. This website itself is build using Precis. Look at the notes below to learn about it.
Precis is a minimal note taking web-app built over Github Pages. This website itself is built using Precis. Look at the notes below to learn about it.

## Tags

@@ -8,4 +8,4 @@ repo_url: https://github.com/abhin4v/precis
name: Precis

# the description of the notes website
description: Precis is a minimal note taking web-app built over Github Pages. This website itself is build using Precis. Look at the notes below to learn about it.
description: Precis is a minimal note taking web-app built over Github Pages. This website itself is built using Precis. Look at the notes below to learn about it.
@@ -68,3 +68,5 @@ First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

You can see the [Markdown source](https://raw.githubusercontent.com/abhin4v/precis/master/demo-note.md) of this note too.
@@ -15,12 +15,14 @@ Precis is a minimal note taking web-app built over Github Pages.
- Read the notes on any device using the generated website.
- Edit the notes on any device using Github's editing UI.
- Do full-text search of your notes.
- Syntax highlighting for code.
- Syntax highlighting for code using [highlight.js].
- Minimal responsive styling using [ReMarkdown.css].
- No dependencies other than basic *nix commands.
- Free public hosting using [Github Pages].
See [setup](./setup) for setup instructions.
[Github Pages]: https://pages.github.com/
[ReMarkdown.css]: https://fvsch.com/remarkdown/
[highlight.js]: https://highlightjs.org/
[Markdown]: https://guides.github.com/features/mastering-markdown/
@@ -7,13 +7,12 @@ tags: documentation

## Requirements

You should have the following commands installed on the computer you want to take notes on:
Precis has no dependencies other than *git* and these basic *nix commands:
- awk
- cat
- cut
- echo
- git
- grep
- sed
- sh

0 comments on commit 63b4652

Please sign in to comment.
You can’t perform that action at this time.