Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

Sign up for GitHub

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

Merged
Eeems merged 2 commits into from
Jan 7, 2026
Merged

Add anchors to faqs, update python, use static sidebar due to limitat… #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07bd862
Add anchors to faqs, update python, use static sidebar due to limitat…
Eeems Jan 7, 2026
3d1f9bb
Build on PR but don't sync
Eeems Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 28 additions & 24 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
push:
branches:
- main
repository_dispatch:
push:
branches:
- main
pull_request:
branches:
- "*"
repository_dispatch:
jobs:
publish:
name: Build and publish the website
runs-on: ubuntu-20.04
steps:
- name: Checkout the Git repository
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Build website
run: make prod
- name: Sync website with the remote repository
uses: ./.github/actions/sync-repository
with:
local-path: dist/
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
ssh-port: ${{ secrets.SSH_PORT }}
remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
publish:
name: Build and publish the website
runs-on: ubuntu-24.04
steps:
- name: Checkout the Git repository
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: "3.13"
- name: Build website
run: make prod
- name: Sync website with the remote repository
if: ${{ github.ref == 'refs/heads/main' }}
uses: ./.github/actions/sync-repository
with:
local-path: dist/
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
ssh-port: ${{ secrets.SSH_PORT }}
remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
30 changes: 3 additions & 27 deletions requirements.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc
View file
Open in desktop
Binary file not shown.
24 changes: 23 additions & 1 deletion src/_themes/toltec/nav.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
{{ toc }}
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="#install-toltec">
Install Toltec
</a></li>
<li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
What Does Toltec
Do?
</a></li>
<li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
Frequently Asked Questions
</a>
</li>
<li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
Packages
</a></li>
<li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
Entware Packages
</a></li>
<li class="toctree-l1"><a class="reference external"
href="https://github.com/toltec-dev/toltec/releases/latest">
Latest Release Notes
</a></li>
</ul>
</nav>
2 changes: 1 addition & 1 deletion src/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down
75 changes: 51 additions & 24 deletions src/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

.. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add anchors to faqs, update python, use static sidebar due to limitat…#17

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.

 Sign up for GitHub

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

 Merged

Eeems
merged 2 commits into

from

Jan 7, 2026
 Merged


Add anchors to faqs, update python, use static sidebar due to limitat…
#17
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
07bd862

Add anchors to faqs, update python, use static sidebar due to limitat…


Eeems Jan 7, 2026
3d1f9bb

Build on PR but don't sync


Eeems Jan 7, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


52 changes: 28 additions & 24 deletions
.github/workflows/publish.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
name: publish
on:
 push:
 branches:
 - main
 repository_dispatch:
 push:
 branches:
 - main
 pull_request:
 branches:
 - "*"
 repository_dispatch:
jobs:
 publish:
 name: Build and publish the website
 runs-on: ubuntu-20.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: '3.8'
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
 publish:
 name: Build and publish the website
 runs-on: ubuntu-24.04
 steps:
 - name: Checkout the Git repository
 uses: actions/checkout@v2
 - name: Setup Python
 uses: actions/setup-python@v2
 with:
 python-version: "3.13"
 - name: Build website
 run: make prod
 - name: Sync website with the remote repository
 if: ${{ github.ref == 'refs/heads/main' }}
 uses: ./.github/actions/sync-repository
 with:
 local-path: dist/
 ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
 ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
 ssh-port: ${{ secrets.SSH_PORT }}
 remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

30 changes: 3 additions & 27 deletions
requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,5 @@
alabaster==0.7.12
Babel==2.9.1
certifi==2021.10.8
charset-normalizer==2.0.7
colorama==0.4.4
docutils==0.17.1
idna==3.3
imagesize==1.2.0
Jinja2==3.0.2
livereload==2.6.3
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.10.0
pyparsing==2.4.7
pytz==2021.3
requests==2.26.0
six==1.16.0
snowballstemmer==2.1.0
Sphinx==4.2.0
sphinx-autobuild==2021.3.14
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
Sphinx==8.0.2
sphinx-autobuild==2024.9.19
sphinxcontrib-fulltoc==1.2.0
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.1
urllib3==1.26.7
Binary file addedsrc/_ext/__pycache__/bootstrap.cpython-313.pyc

View file


Open in desktop


Binary file not shown.


24 changes: 23 additions & 1 deletion
src/_themes/toltec/nav.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
<nav class="sidebar-nav">
 {{ toc }}
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
 Install Toltec
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
 What Does Toltec
 Do?
 </a></li>
 <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
 Frequently Asked Questions
 </a>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
 Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
 Entware Packages
 </a></li>
 <li class="toctree-l1"><a class="reference external"
 href="https://github.com/toltec-dev/toltec/releases/latest">
 Latest Release Notes
 </a></li>
 </ul>
</nav>

2 changes: 1 addition & 1 deletion
src/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
html_title = "Toltec"
html_theme = "toltec"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"

extensions = [
Expand Down

75 changes: 51 additions & 24 deletions
src/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,50 +86,77 @@ Frequently Asked Questions
==========================

Where can I get help?
 If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
 Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
---------------------

If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.

Is this supported by reMarkable AS?
 No, this is a community project.
-----------------------------------

No, this is a community project.

Will this brick my reMarkable?
 Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
------------------------------

Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.

Do you support reMarkable 2?
 Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
---------------------------------

Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.

Do you support reMarkable Paper Pro or Move?
--------------------------------------------

Not at this time.

Why doesn't toltec support the latest OS version as soon as it comes out?
 Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
-------------------------------------------------------------------------

Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.

Can I add `__________` to Toltec?
 We’re always open to adding new packages to the repository.
 You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
---------------------------------

We’re always open to adding new packages to the repository.
You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.

I found a vulnerability in Toltec or one of its packages, where can I report it?
 To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
-------------------------------------------------------------------------------------

To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.

Can I factory reset my reMarkable if I have toltec installed?
 No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
-------------------------------------------------------------

No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.

Why can't I install toltec before my OS is supported?
 `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
-----------------------------------------------------

`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

Why doesn’t toltec support the beta OS versions?
 `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
------------------------------------------------

`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.

My reMarkable seems to have become unresponsive, how do I fix it?
 If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
-----------------------------------------------------------------

 * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
 * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

 If you can SSH in through USB, the following may work:
If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:

 .. parsed-literal::
* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.

If you can SSH in through USB, the following may work:

.. parsed-literal::

rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
systemctl unmask sync.service || systemctl unmask rm-sync.service
systemctl disable --now manual-sync.service
systemctl daemon-reload
systemctl reset-failed xochitl
systemctl restart xochitl
 rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
 systemctl unmask sync.service || systemctl unmask rm-sync.service
 systemctl disable --now manual-sync.service
 systemctl daemon-reload
 systemctl reset-failed xochitl
 systemctl restart xochitl