GithubHelp home page GithubHelp logo

lute-manual's People

Contributors

fanyingfx avatar jzohrab avatar shetozz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

shetozz fanyingfx

lute-manual's Issues

Commit all assets to `/src/assets/` folder, with sensible names, and use them in pages

Currently, the manual uses various github user content and github assets files for image sources. The images were copied-pasted into github issues, and then the resulting urls were copied into the .md files.

This will cause problems when the manual is moved to the new LuteOrg repo, because those old assets can disappear. The images should just be committed to this repo. Bloat, who cares, it's clearer.

For the images to work with both local mdbook build and gh pages deployment, the image source should be committed to src/assets, and then the images referred to by relative paths, e.g, from project root:

$ ls src/assets/
testit.png
$ cat src/install/install.md 
# Installation
...
![image](../assets/testit.png)

When this is done, the local site should be fine even if wifi is turned off.

  • ./SUMMARY.md
  • ./intro.md
  • ./404.md
  • ./background.md
  • ./misc/changelog.md
  • ./misc/doc-feedback.md
  • ./misc/backlog.md
  • ./install/troubleshooting.md
  • ./install/beta-releases.md
  • ./install/install.md
  • ./install/windows/windows-10-32-bit-using-python.md
  • ./install/windows/windows-using-docker.md
  • ./install/windows/index.md
  • ./install/mecab.md
  • ./faq/import-from-other-systems.md
  • ./faq/v2-to-v3.md
  • ./faq/free.md
  • ./faq/prioritizing-dev-work.md
  • ./faq/terms/sentences-only-shown-when-page-is-read.md
  • ./faq/terms/terms-cannot-be-changed-once-created.md
  • ./faq/terms/term-statuses.md
  • ./faq/setup/usb.md
  • ./faq/setup/web-server.md
  • ./faq/language/dict-not-working.md
  • ./faq/language/add-a-language.md
  • ./faq/books/pdf-import.md
  • ./faq/books/finding-stuff.md
  • ./faq/books/utf-8.md
  • ./faq/books/epub-import.md
  • ./faq/help.md
  • ./faq/online-lute.md
  • ./faq/why-no-flashcards.md
  • ./faq/adding-basic-auth.md
  • ./usage/reading/overlapping-terms.md
  • ./usage/reading/tutorial.md
  • ./usage/reading/reading.md
  • ./usage/terms/link-parent-child-statuses.md
  • ./usage/terms/parent-terms.md
  • ./usage/terms/bulk-term-import.md
  • ./usage/terms/terms.md
  • ./usage/audio.md
  • ./usage/updating.md
  • ./usage/books/stats.md
  • ./usage/books/creating-books.md
  • ./usage/languages/dictionaries.md
  • ./usage/languages/defining-languages.md
  • ./usage/languages/word-characters.md
  • ./usage/starting-and-stopping.md
  • ./usage/command-line-jobs.md
  • ./usage/themes/toggling-highlights.md
  • ./usage/themes/themes.md
  • ./usage/themes/custom-styles.md
  • ./usage/keyboard-bindings.md
  • ./backup/restore.md
  • ./backup/backup.md
  • commit all images, fix all pages
  • check local site displays correctly when wifi is turned off
  • push, check all pages once published

There's a link that returns an error

Jz just a small error, in the updating lute page when it says "First, you must stop Lute", I tried to open that link but it returns, "Document not found (404)"
image
image
Thanks ;)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.