vnotex / vnotex/vnote

Asciidoctor support

Open
#1,233 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
13k
Forks
1.3k
Avg merge
14h 3m
Merged PRs (30d)
3

Description

This is the best note-taking app I ever seen. (I even copy-pasted to my own notes some of your design-related quotes from the related Hacker News thread.)

I would to propose a feature to add Asciidoctor markup. Asciidoctor is a great markup language with a lot of features.

The reference implementation is written in Ruby, but there is an official JavaScript port, AsciidoctorJS:

I don't think we need all Asciidoctor features in Vnote, but it will be great to have at least the basic ones, like bold, italic, code blocks, etc.

P.S. By the way, Asciidoctor is supported in GitHub READMEs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the linked Asciidoctor user manual and compare the Ruby reference implementation with AsciidoctorJS. Define which basic markup features Vnote should support and how completion will be tested; the issue does not name source files, tests, or an entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, ruby
Domain
content, desktop
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.