Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pavus roadmap #3

Open
8 of 22 tasks
kauefraga opened this issue Oct 5, 2024 · 1 comment
Open
8 of 22 tasks

Pavus roadmap #3

kauefraga opened this issue Oct 5, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kauefraga
Copy link
Owner

kauefraga commented Oct 5, 2024

Pavus should be simple, here's the features

Markdown preview
  • $ pavus [markdown] and $ pavus with recursive search
  • Rendering (markdown to html, markdown-it)
  • Hot reloading (fsnotify and server-sent events)
  • Syntax highlighting (shiki)
  • LaTeX (KaTeX?) and Mermaidjs
  • Images (need to adjust the image path in the markdown to point to the server)
  • Default theme
Templates
  • $ pavus init or $ pavus init --template "x" --output "xyz.md" --language "pt-br" - create markdown based in a template (aliases: create, c) [43d946c]
  • $ pavus templates - list available templates [b73cbf9]
  • $ pavus fill [markdown] - generate prompts to fill markdown's template gaps
  • $ pavus doc - modify a markdown document
    • $ pavus doc add --section "x" - append a template section
    • $ pavus doc remove --section "x" - pop a template section
Helpers
  • $ pavus list - recursively find and list markdown files (aliases: find, ls)
  • $ pavus open - open a markdown file with the set $EDITOR
Configuration

The idea is to store a pavus.toml in the user's home directory (~).

Dependencies: go-toml, xdg.

  • $ pavus config - init config or show where it is (and the values of existing configs)
  • $ pavus config [key] [value] - set a config
  • Themes (preview render)
  • Port (preview server)
  • Open browser (preview option)
  • AI token
  • Custom templates
AI
  • Fill template gaps
  • Write a markdown based in a prompt
@kauefraga kauefraga added the documentation Improvements or additions to documentation label Oct 5, 2024
@kauefraga kauefraga self-assigned this Oct 6, 2024
@kauefraga
Copy link
Owner Author

Template internationalization would be nice...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant