https://github.com/paul-wolf/yewdoc-client

client app for yewdoc
https://github.com/paul-wolf/yewdoc-client

cloud command-line document-management markdown pandoc python

Last synced: 9 days ago
JSON representation

client app for yewdoc

• Host: GitHub
• URL: https://github.com/paul-wolf/yewdoc-client
• Owner: paul-wolf
• License: other
• Created: 2015-06-28T16:22:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T21:36:47.000Z (almost 2 years ago)
• Last Synced: 2024-04-17T07:15:36.183Z (7 months ago)
• Topics: cloud, command-line, document-management, markdown, pandoc, python
• Language: Python
• Homepage:
• Size: 639 KB
• Stars: 8
• Watchers: 5
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
YEWDOCS

=======

[![Run pytest](https://github.com/paul-wolf/yewdoc-client/actions/workflows/main.yml/badge.svg)](https://github.com/paul-wolf/yewdoc-client/actions/workflows/main.yml)

[![Documentation Status](https://readthedocs.org/projects/yewdocs/badge/?version=latest)](https://yewdocs.readthedocs.io/en/latest/?badge=latest)

Yewdocs is a personal document manager that makes creating and editing

text documents from the command line easier than using only an editor

and filesystem commands.

[Full documentation](https://yewdocs.readthedocs.io)

Yewdocs is for *text* documents: plain text, restructuredText,

markdown, conf, etc. It offers these features:

* Filesystem transparency: the user doesn't need to know where files

  are stored.

* Entirely keyboard driven.

* Tags: define tags and organise your documents with them.

* Familiar commands: yewdocs has commands like 'ls', 'head', 'tail',

  that are familiar to most shell users.

  

* Optional cloud storage for synchronising to multiple

  devices/workstations.

* Document conversions: it will generate any format that pandoc is

  able to convert to/from. There is special support for generation of

  html and the use of templates.

  

* Integration with other command line utilities: as just another shell

  utility, you can do normal shell piping in and out, grep, etc.

Think of it as a command line note taking application. 

The target users are those who prefer to work on the command line

without the overhead of switching back and forth between a shell and

the host OS GUI. When working regularly on the command line, it is a

considerable annoyance to have to break out to use the host OS file

management app to find files and use the mouse. Yewdocs lets the user

seamlessly browse and operate on her collection of text files. These

can be snippets, larger documents, notes, etc. Exporting to other

formats is easy and natural.

A major design goal is to reduce the mental overhead of finding

files. Once a file is managed by Yewdocs, it is easy to perform

operations like editing it without needing to remember the exact name

or location. Documents can be managed by Yewdocs either within its own

repository or in-place as linked documents.

You are not forced to choose between your favourite non-text editor

and shell editor. You can just as well use Sublime, Atom or other

non-console interfaces for editing Yewdocs documents.

It's possible to maintain text documents on a server and sync to any

local device that supports Python (>= 3.6) and one of the common *nix

shells.

You can edit and manage any kind of text file, txt, rst, md, conf,

etc. Yewdocs does have a slight prejudice towards Markdown for newly

created documents but you can easily specify any format you wish or

convert a file to another format after creating it.

Copyright Paul Wolf