digineo / texd

texd wraps TeX in a web API
MIT License
8 stars 1 forks source link

Render documentation #35

Open dmke opened 2 years ago

dmke commented 2 years ago

This moves most of the contents from the README into /docs.

I want to render the content in two places:

  1. https://github.com/digineo/texd/blob/docs/docs/README.md should show the latest documentation. After merging, the URL will be .../blob/master/..., and tagged releases can have their stable docs at .../blob/vX.Y.Z/...
  2. http://localhost:2201/docs should render the documentation for the instance running on localhost:2201.

Several files exist to support instance-local rendering. All of them will be embedded in the binary:

codecov[bot] commented 2 years ago

Codecov Report

Merging #35 (1a7436b) into master (d9aa4f2) will decrease coverage by 0.14%. The diff coverage is 57.14%.

@@            Coverage Diff             @@
##           master      #35      +/-   ##
==========================================
- Coverage   80.90%   80.76%   -0.15%     
==========================================
  Files          30       30              
  Lines        1592     1596       +4     
==========================================
+ Hits         1288     1289       +1     
- Misses        243      244       +1     
- Partials       61       63       +2     
Impacted Files Coverage Δ
service/service.go 63.46% <40.00%> (-1.19%) :arrow_down:
service/ui.go 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d9aa4f2...1a7436b. Read the comment docs.