Skip to content

Commit

Permalink
add links to RSS feeds to watch for new changes
Browse files Browse the repository at this point in the history
  • Loading branch information
pysan3 committed Dec 26, 2023
1 parent e67fae9 commit fa8fa73
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,42 @@ git clone https://github.com/pysan3/Norg-Tutorial.git
cd Norg-Tutorial/
```

I'd suggest reading `norg_tutorial.md` first to do the installation and then clone the repo locally
I'd suggest reading [`./norg_tutorial.norg`](./norg_tutorial.norg)
first to do the installation and then clone the repo locally
to read `norg_tutorial.norg` in your neovim with the neorg plugin :)

**The kickstart config is only compatible with v3.0.0+**

Update the plugin if it is on an old version.

## Before You Start

I recommend installing these documents.

- `specifications.norg`: [https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg](https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg)
- `specifications.norg`: <https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg>
- Complete document about the specifications of `norg` format.
- `wget https://raw.githubusercontent.com/nvim-neorg/norg-specs/main/1.0-specification.norg`
- No LICENSE
- `neorg.norg`: [https://github.com/nvim-neorg/neorg/blob/main/doc/neorg.norg](https://github.com/nvim-neorg/neorg/blob/main/doc/neorg.norg)
- `neorg.norg`: <https://github.com/nvim-neorg/neorg/blob/main/doc/neorg.norg>
- Document about how to manipulate text. e.g. **bold**, _italisize_ etc.
- `wget https://raw.githubusercontent.com/nvim-neorg/neorg/main/doc/neorg.norg`
- GPL v3.0

## `norg` Tutorial
## [`norg` Tutorial](./norg_tutorial.md)

- [`./norg_tutorial.norg`](./norg_tutorial.norg)
- [`./norg_tutorial.md`](./norg_tutorial.md)
- Generated from `./norg_tutorial.norg`. Might be inaccurate
- Generated from `./norg_tutorial.norg`. Might be inaccurate.

I'd suggest reading `norg_tutorial.md` first to do the installation
and then clone the repo locally to read `norg_tutorial.norg` in your neovim
with the neorg plugin :)

## Watch for Updates

### RSS Feeds

- `./norg_tutorial.norg`: <https://github.com/pysan3/Norg-Tutorial/commits/main/norg_tutorial.norg.atom>
- `./norg_tutorial.md`: <https://github.com/pysan3/Norg-Tutorial/commits/main/norg_tutorial.md.atom>

### GitHub Watch

[![GitHub watchers](https://img.shields.io/github/watchers/pysan3/Norg-Tutorial.svg?style=social&label=Watch&maxAge=2592000)](https://github.com/pysan3/Norg-Tutorial/)

I'd recommend you read `./norg_tutorial.norg` on your local neovim with tree-sitter enabled
but you can also read the conterved markdown on GitHub (which might be inaccurate).
Watch the whole repo and get notifications from GitHub.

0 comments on commit fa8fa73

Please sign in to comment.