remarkable.guide

A guide for hacking your reMarkable tablet.

Can I make changes?

Pull Requests and Issues are welcome! The site is built with Sphinx and images are generated with TikZ.

How do I build the site?

You will need the following installed:

build-essential
graphviz
libgraphviz-dev
librsvg2-bin
pdf2svg
pipenv
python
texlive-base
texlive-latex-extra

At which point in time you can build the site with make.

If you would like to have the site automatically update as you change files in src, you can run make dev. This will open the build of the site in your browser, and auto update the page when you make changes. If you would like to automatically update src/_static/images as you make changes to images, you can run make dev-images.

How do I add a page to the site?

Create a new *.rst file in src.

How do I add a link to a page to the sidebar?

Add it's name to src/sitemap.rst.

How do I add a picture to the site?

Adding an image to the site can be done by adding a *.png.tex or *.svg.tex file in images, or adding the image itself to src/_static. Please don't add them directly to src/_static/images as this will be replaced by images generated by images as part of the build process.

Can I change the text in a header?

Yes, but you'll need to add a label using the previous text so that old hyperlinks will continue to work.