Skip to content

Latest commit

 

History

History
107 lines (69 loc) · 2.27 KB

guide_docusaurus.rst

File metadata and controls

107 lines (69 loc) · 2.27 KB
Raw
.. author:: Thomas Kammerer <https://kammerer.tk/>

.. tag:: lang-nodejs
.. tag:: web
.. tag:: documentation

Logo

Docusaurus

.. tag_list::

Docusaurus makes it easy to maintain Open Source documentation websites.

Note

For this guide you should be familiar with the basic concepts of

Prerequisites

Node and npm

We're using :manual:`Node.js <lang-nodejs>` in the latest version:

[isabell@stardust ~]$ uberspace tools version show node
Using 'Node.js' version: '12'
[isabell@stardust ~]$

Your website domain needs to be set up:

Installation

We create the application directory and install the latest version. The website is created with docusaurus-init.

[isabell@stardust ~]$ mkdir docusaurus
[isabell@stardust ~]$ cd docusaurus
[isabell@stardust docusaurus]$ npm install --global docusaurus-init
(...)
[isabell@stardust docusaurus]$ docusaurus-init
(...)
[isabell@stardust docusaurus]$

Setup daemon

Create ~/etc/services.d/docusaurus.ini with the following content:

[program:docusaurus]
directory=%(ENV_HOME)s/docusaurus/website
command=npm start
autostart=yes
autorestart=yes

Configure web server

Note

Docusaurus is running on port 3000.

Updates

Note

Check the update feed regularly to stay informed about the newest version.

[isabell@stardust ~]$ supervisorctl stop docusaurus
[isabell@stardust ~]$ cd docusaurus
[isabell@stardust docusaurus]$ npm update docusaurus
[isabell@stardust docusaurus]$ supervisorctl start docusaurus
[isabell@stardust docusaurus]$

Tested with Docusaurus 1.14.4 and Uberspace 7.6.12

.. author_list::