Skip to main content

A minimalist document bundler designed for stitching hints, reminders and short docs.

Project description

Nanodoc
--------

Nanodoc is a minimalist document bundler designed for stiching hints, reminders and short docs.
Useful for prompts, personalized docs highlights for your teams or a note to your future self

No config, nothing to learn nor remember. Short , simple, sweet.

Features
--------

- No config, no tutorial, no pain.
- Combines multiple text files into a single document
- Adds clear title separators between pages
- Supports optional line numbering (per file or global)
- Can generate a table of contents
- Flexible file selection methods
- Customizable header styles and sequence numbering

Usage
-----

$ nanodoc file1.txt file2.txt


$ nanodoc -n file1.txt file2.txt # Per-file line numbering
$ nanodoc -nn file1.txt file2.txt # Global line numbering
$ nanodoc -nn --toc file1.txt file2.txt # Global numbering with TOC

File Selection Options
----------------------

Nanodoc is flexible in how you specify the files to bundle:

$ nanodoc <file-1>...<file-n> # individual files
$ nanodoc <dir-name> # all txt and md files in the dir will be included
$ nanodoc <dir-name> <file-1> # mix and match as yould like
$ nanodoc <bundle> # any .bundle.* file that is a list of paths, one per line

Get only parts of a file:

$ nanodoc readme.txt:L14-16,L30-50 # get the good parts only

Command Line Options
--------------------

- `-n`: Add per-file line numbering (01, 02, etc.)
- `-nn`: Add global line numbering: useful for referencing the full doc gen later
- `--toc`: Generate a table of contents at the beginning

Get fancy
---------

- `--seq`: numerical, roman or letter for ref the file sequence
- `--style`: nice (Human Readable (human-readable.txt), or file, or full-path

Save for later:
---------------

Generated a doc good enough to repeat, export the bundle

$nanodoc --export-bundle bestdocs.bundle.txt <file-1>...<file-n>

Keep it simple
--------------

Nothing to config.
Nothing to learn.
No tutorials to watch.

In fact, you've just went through the full documentation.
$ nanodoc --help # all there is


## Installation

nandoc is available at a distributor near you:

pip install nanodoc
brew install nanodoc
apt-get install nanodoc


## Contributing

Contributions are welcome! Say hi, curse me for eternety or even send in something constructive.
Feel free to open issues or submit pull requests.

(just keep it short, we're nano people after all)

## License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nanodoc-0.1.1.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nanodoc-0.1.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file nanodoc-0.1.1.tar.gz.

File metadata

  • Download URL: nanodoc-0.1.1.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for nanodoc-0.1.1.tar.gz
Algorithm Hash digest
SHA256 439e84b4a183b26c1514e352cdabdb850fee02e5ed17f59ecf3395cab23f787c
MD5 9ebeb1c9349155b300cc067655332083
BLAKE2b-256 fa3839b076d5a276f76a617a9eda51899579ddb2aed76821b17c5a1d0dc523a7

See more details on using hashes here.

File details

Details for the file nanodoc-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nanodoc-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for nanodoc-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 94c0d485007f3e6c3acb419aab6acc1c3e4bcfdaf6829e5732c16a7aad2e1568
MD5 b12168515cdcc0666bbb2e5e031546ec
BLAKE2b-256 201bc4aca5aa562c34e642cea7c954155a049757193cd9d39dedab3482f71aad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page