anno - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #llm #android #machine-learning #linux #docker #java #windows #cli #kubernetes #pytorch #openai

anno

(★ 132)

Anno is a thin user interface on Markdown files for easy and local text editing, organization, and portability.

File Explorer

Download Latest Version (.zip)

- - __init__.py
  - app.py
  - config.py
  - notes.py
  - render.py
- __init__.py
- annoapp.py
- 2019-12-01-a-tutorial-how-to-use-anno.anno.md
- editing_0.0.3.png
- editing_0.0.5.png
.gitignore
MANIFEST.in
README.md
release.sh
setup.py

# Installation Guide

1. Get the code

git clone https://github.com/gwgundersen/anno

Downloads the entire project code from GitHub to your computer.

cd anno

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install anno

Installs the package published on PyPI directly — no need to clone the source.

pip install dist/anno-<VERSION>.tar.gz

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install anno

Installs the package published on PyPI directly — no need to clone the source.

pip install dist/anno-<VERSION>.tar.gz

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Anno - simple, local, portable note-taking software

## Why use Anno?

There are many note-taking apps. How is Anno different? Anno is a local, browser-based user interface on top of [Markdown](https://daringfireball.net/projects/markdown/) files in a given directory. It makes writing, organizing, and searching through those files easy. That's it. There are many benefits to this approach:

- **Own your data.** Writing things down is an investment in your future. Rather than have your notes siloed by a company in a possibly proprietary text format, your data lives in plaintext files on your machine. If you use Anno for a while and then stop, no worries. Your data, Markdown files, is human-readable, easily portable to other tools, and programmatically convertable to other formats (e.g. see [Pandoc](https://pandoc.org/)).

- **Organize notes naturally.** Most note-taking apps create a new organizational system for your notes that is distinct from your filesystem. This forces you to store your notes separately from related files. Anno only works with `.anno.md` files in the current working directory, allowing you to organize your notes using your filesystem. Furthermore, all files with `labels` in the [YAML](https://yaml.org/)-style front matter can be viewed in their respective collections, making intra-directory organization easy without touching your underlying directory structure.

- **Use other software.** Anno adheres to the [Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy) of modular software that is simple, short, clear, and extensible. For example, data redundancy for text files is a solved problem, and Anno does not control users through product integration. Want cloud backups? Push to a git server or work out of a directory with file syncing. Want security? Encrypt the directory. Anno focuses on easy Markdown editing and organization.

- **Stay local, work fast.** Do you want to work on a plane or a train? Do you want a fast, simple user interface that isn't pinging a remote server or downloading large front-end interfaces? Anno is fast—it uses a small Flask server and one ~100 line JavaScript file—and can be used anywhere.

## What Anno supports

Anno provides a user interface for the most common and/or time-consuming text-editing operations.

<img src='https://raw.githubusercontent.com/gwgundersen/anno/master/screenshots/editing_0.0.5.png'/>

Anno supports:

- Previewing changes as you write.
- Writing equations using [Katex](https://katex.org/).
- Searching through files.
- Organizing notes in a directory with labels.
- Adding images to notes.
- Syncing Markdown front matter (title and date) into consistently formatted filenames.
- Converting notes into [LaTeX](https://www.latex-project.org/) PDFs for easy printing and sharing.
    
## Installation

### From PyPI

Anno is available as a [PyPI package](https://pypi.org/project/anno/). To install, run

```bash
pip install anno
```

### From source

You can also install the current development version by building and installing:

```bash
git clone git@github.com:gwgundersen/anno.git
cd anno
python setup.py sdist
pip install dist/anno-<VERSION>.tar.gz
```

### Tex

To use Katex or the PDF converter, you need [Pandoc](https://pandoc.org/) and the `pdflatex` command. Otherwise, Anno falls back on [python-markdown2](https://github.com/trentm/python-markdown2).

## Usage

To use Anno, type `anno` in the desired directory, e.g.

```bash
cd ~/myproject
anno
```

and Anno will start a web server on port 5000 and open the app with your default browser. The port can be changed with the `--port` flag, e.g.

```bash
anno --port=4000
```

If you would prefer Anno did not open a new browser tab, pass the `--nopen` flag:

```bash
anno --nopen
```

You can customize Anno using an `.anno_config.py` file. To generate this file, run

```bash
anno --generate-config
```

This allows for customizations such as changing how dates are rendered, how filenames are constructed, and which file extensions are used by default.