https://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
• enchant-2

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.

You can run make spelling to just check spelling of the guide.

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/images. Please don't add them directly to src/images/_generated as this will be replaced by images generated by images as part of the build process.

To add a picture to a page you can use the following:

.. image:: /images/path/to/file-1.png
  :alt: First picture

For example, to add the favicon you can use the following:

.. image:: /images/_generated/favicon.svg
   :alt: reMarkable Tablet
   :class: logo

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: .. _previous-text:. Make sure to test this as well.

Can I rename a page?

Yes, you usually will want to accomplish this by just changing the first header on a page, but if you ever need to change the filename of the page, you will need to recreate the old page and have it redirect to the new page. This way links will continue to work.

This page has been moved to :doc:`new-page-name`.

.. raw:: html

  <noscript>
    <meta http-equiv="refresh" content="0; url=/new-page-name.html"/>
  </noscript>
  <script>
    location.pathname = "/new-page-name.html";
  </script>

How to I add a warning to a page?

:raw-html:`<div class="warning">⚠️ Warning title. ⚠️`

Warning text.
:raw-html:`</div>`

How do I add screenshots to a page?

:raw-html:`<div class="gallery">`

.. image:: /images/path/to/file-1.png
  :class: screenshot
  :alt: First screenshot


.. image:: /images/path/to/file-2.png
  :class: screenshot
  :alt: Second screenshot

:raw-html:`</div>`

How do I mark a page as a stub that needs further content written?

Ideally you don't add stub pages, but sometimes it's better to just add a page and throw a couple links on it for future completion.

:raw-html:`<div class="warning">⚠️ FIXME. ⚠️`

This page is just a stub that needs to be completed. You can `open a PR on the repo <https://github.com/Eeems-Org/remarkable.guide>`_ to add more content to the page.
:raw-html:`</div>`

How do I add grouped tabs with examples of commands for different shells?

.. tabs::

  .. code-tab:: bash Linux

    ssh root@10.11.99.1

  .. code-tab:: bash macOS

    ssh root@10.11.99.1

  .. code-tab:: bat Windows (CMD)

    ssh root@10.11.99.1

  .. code-tab:: pwsh Windows (PowerShell)

    ssh root@10.11.99.1