https://beancount.github.io/docs/

Beancount Documentation.
https://beancount.github.io/docs/

beancount mkdocs-site pandoc

Last synced: 12 days ago
JSON representation

Beancount Documentation.

• Host: GitHub
• URL: https://beancount.github.io/docs/
• Owner: beancount
• License: mit
• Created: 2019-06-24T11:46:51.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-01T06:59:33.000Z (15 days ago)
• Last Synced: 2024-06-01T08:09:36.913Z (15 days ago)
• Topics: beancount, mkdocs-site, pandoc
• Language: Python
• Homepage: https://beancount.github.io/docs/
• Size: 22 MB
• Stars: 39
• Watchers: 7
• Forks: 28
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-beancount - GitHub Pages

README

        
# Beancount Documentation

https://beancount.github.io/docs/

Source files are in [docs](docs/) directory.

These documents in markdown format are automatically generated from [official Beancount documentation](http://furius.ca/beancount/doc/index).

You [can contribute](CONTRIBUTING.md).

## Beancount Google Doc converter

### Installation

The converter requires python 3.6 - 3.10.

Create virtualenv (recommended):

```

python3 -m venv venv

. venv/bin/activate

```

Install dependencies:

```

pip install -r requirements.txt

```

### Usage

Export and convert single document:

```shell

# Export google document as docx file

python export.py document "100tGcA4blh6KSXPRGCZpUlyxaRUwFHEvnz_k9DyZFn4" doubleentry.docx

# Export drawings

python export.py drawings "100tGcA4blh6KSXPRGCZpUlyxaRUwFHEvnz_k9DyZFn4" drawings

# Convert docx file to markdown

python export.py convert doubleentry.docx doubleentry.md --drawing-dir=drawings

```

Export and convert all documents:

```

python crawl.py

```

## Documentation website

Generate static website using [MkDocs](https://www.mkdocs.org/):

```

python build.py serve

```

Deploy to GitHub pages:

```

python build.py gh-deploy

```