Skip to content

The generator for stubbed out markdown files I use to take notes.

License

Notifications You must be signed in to change notification settings

trueheart78/book-notes-generator

Repository files navigation

Book Notes Generator 📝 CircleCI

Companion to Book Notes

  1. Outstanding Tasks
  2. Development
  3. Adding a Book
    1. Configuration
    2. Creating YAML For a Book
    3. Importing a book
    4. Sample Book YAML
    5. Sample Output

Outstanding Tasks

  • Write tests for the Import Controller
  • Write tests for the Notes Generator

Development

Make sure bundler is installed, and then run bundle install.

Tests can be run with bundle exec rake test. Tests are written using Minitest.

Adding a Book

Configuration

Make a local copy of the config.default.yml file:

cp config.default.yml config.local.yml

Edit config.local.yml with a full path for book_notes_path, the proper yaml_directory, and the notes_directory. Leaving either of the directories blank is allowed, and for the notes_directory, likely desired.

Creating YAML For a Book

Books can be added by creating a book-name.yml file in the yaml_directory location defined in the config file.

You can create the YAML file by running:

./create book-name

Importing a Book

To generate the proper note structure for a new book, run:

./import book-name

And follow the prompts.

Sample Book YAML

There are two different supported formats for book YAML. The earlier version did not support sectioned content, but is still applicable for many books out there.

Without Sections

The :appendices: portion is optional.

---
:title: An Awesome Book
:purchase: http://buyonline.example.com
:author: That One Girl
:homepage: http://www.thatonegirl.com/
:image: https://image.example.com/an-awesome-book/
:image_ext: jpg

:chapters:
  - The Intro Chapter
  - The Second Chapter
  - The Third Chapter
  - The Fourth Chapter
  - In Closing

:appendices:
  - The First Appendix
  - The Second Appendix

With Sections

An empty section name is seen as nil, and will not cause a section title to be written out.

---
:title: An Awesome Book
:purchase: http://buyonline.example.com
:author: That One Girl
:homepage: http://www.thatonegirl.com/
:image: https://image.example.com/an-awesome-book/
:image_ext: jpg

:sections:
  -
    :name:
    :chapters:
    - The Intro Chapter
  -
    :name: Part 1. Kicking Butt
    :chapters:
    - The Second Chapter
    - The Third Chapter
  -
    :name: Part 2. Taking Names
    :chapters:
    - The Fourth Chapter
    - In Closing
  -
    :name: Appendices
    :chapters:
      - The First Appendix
      - The Second Appendix

Sample Output for Sections

After you save the above as yaml/sample-book.yml, and run ./import sample-book, you should see the following:

- Directory: an-awesome-book
- Title: An Awesome Book
- Purchase: http://buyonline.example.com
- Author: That One Girl
- Homepage: http://www.thatonegirl.com/
- Image? true [jpg]
   https://image.example.com/an-awesome-book/
- Chapters: 7
   01. The Intro Chapter - ch01-the-intro-chapter.md
   Part 1. Kicking Butt
     02. The Second Chapter - ch02-the-second-chapter.md
     03. The Third Chapter - ch03-the-third-chapter.md
   Part 2. Taking Names
     04. The Fourth Chapter - ch04-the-fourth-chapter.md
     05. In Closing - ch05-in-closing.md
   Appendices
     01. The First Appendix - ap01-the-first-appendix.md
     02. The Second Appendix - ap02-the-second-appendix.md
---------------------
Import 'An Awesome Book' by That One Girl :: 7 chapters? (y/n)

Entering y will generate the proper files in the noted directory, download the image (if it is valid), and inform you of this task:

**********************************************************************

Please add the following to the root book-notes README.md file:

1. [An Awesome Book](an-awesome-book/README.md)

**********************************************************************

Book notes generated successfully.

About

The generator for stubbed out markdown files I use to take notes.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages