Writing Folder

In can, your 'writing folder' is the directory on your computer which contains your current working documents and your notebook.

You can pull notes out of your notebook into your writing folder for reading or editing, check the status of your notes, and write new notes which can be inserted into your notebook. It might help to think about it as a writing desk.

Any links you make between notes in the writing desk will be preserved when adding the note to your notebook.

You can add your whole writing folder to git for version control - the important part is your notebook, which is stored in the .notebook directory.

Backlinks

• Notebook
  • In can, your notebook is the collection of all your notes. Using can, you can search and shuffle through these notes and pull them into your writing folder for working with.
• The default note file will be markdown
  • can should process notes in the writing folder as markdown by default. Can should allow for multiple formats of notes in the future.
• can-add
  • The can-add command is used to add notes into the notebook from the writing folder.
• can-status
  • The can-status command should report when markdown files in the writing folder are new to the notebook and can be added. The default note file will be markdown, but can should allow for multiple formats of notes
• can : core concepts
  • the writing folder
• Locality
  • can is entirely local. Your notes are stored on your machine, wherever you've set up your writing folder. You can use tools like git to sync your files across machines (which should work really well), but can core tools should never access your network. It is possible that some tools will be built to aid syncing / working in a distributed manner - but those will be explicit and entirely opt-in if and when they exist at all.
• can-new
  • The can-new command should create a new writing folder and notebook in the directory they are called in. The writing folder should be named writing-folder and should contain an empty .notebook directory.
• can-note-graph
  • Error code 4 may only be used for referencing notes which don't exist at all in the future. can-note-graph may start to check inside the notebook for a note with a name. For now, pull all notes you're linking to into the writing folder before running can-note-graph