You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/intro/add-project.rst
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Adding a documentation project
5
5
:description lang=en: Add your existing documentation from a Git repository into Read the Docs.
6
6
7
7
This page takes you through the process of adding a documentation project to Read the Docs.
8
-
If you have :doc:`connected your Read the Docs account </guides/connecting-git-account>` to GitHub, Bitbucket or GitLab you will be able to add your project automatically.
8
+
If you have :doc:`connected your Read the Docs account </guides/connecting-git-account>` to GitHub, Bitbucket, or GitLab, you will be able to add your project automatically.
9
9
Otherwise, you will need to add it manually and perform some extra steps.
10
10
11
11
Automatically add your project
@@ -17,7 +17,7 @@ Automatically add your project
17
17
#. Click on :guilabel:`Continue`.
18
18
#. Edit any of the pre-filled fields with information of the repository.
19
19
#. Click on :guilabel:`Next`.
20
-
#. Add a :term:`configuration file` to your repository if it's doesn't exist yet.
20
+
#. Add a :term:`configuration file` to your repository if it doesn't exist yet.
21
21
#. Click on :guilabel:`This file exists`.
22
22
23
23
.. seealso::
@@ -35,7 +35,7 @@ Manually add your project
35
35
#. Click on :guilabel:`Continue`.
36
36
#. Fill all the fields of the form.
37
37
#. Click on :guilabel:`Next`.
38
-
#. Add a :term:`configuration file` to your repository if it's doesn't exist yet.
38
+
#. Add a :term:`configuration file` to your repository if it doesn't exist yet.
39
39
#. Click on :guilabel:`This file exists`.
40
40
41
41
Once your project is created, you'll need to manually configure the repository webhook if you would like to have new changes trigger builds for your project on Read the Docs.
@@ -45,7 +45,6 @@ Once your project is created, you'll need to manually configure the repository w
45
45
:doc:`/guides/setup/git-repo-manual`
46
46
Additional setup steps required for manually created projects. This guide covers setting up SSH keys and webhook integrations.
Copy file name to clipboardExpand all lines: docs/user/intro/docusaurus.rst
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,30 @@
1
-
Docusarus
2
-
=========
1
+
Docusaurus
2
+
==========
3
3
4
4
.. meta::
5
5
:description lang=en: Hosting Docusaurus sites on Read the Docs.
6
6
7
7
`Docusaurus`_ is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features.
8
8
9
9
Minimal configuration required to build a Docusaurus project on Read the Docs looks like this,
10
-
specifying a nodejs toolchain on Ubuntu, using multiple :ref:`build <config-file/v2:build>` jobs to install the requirements,
10
+
specifying a Node.js toolchain on Ubuntu, using multiple :ref:`build <config-file/v2:build>` jobs to install the requirements,
11
11
build the site, and copy the output to $READTHEDOCS_OUTPUT:
12
12
13
13
.. code-block:: yaml
14
14
:caption: .readthedocs.yaml
15
15
16
16
version: 2
17
17
build:
18
-
os: "ubuntu-22.04"
19
-
tools:
18
+
os: "ubuntu-22.04"
19
+
tools:
20
20
nodejs: "18"
21
-
jobs:
21
+
jobs:
22
22
# "docs/" was created following the Docusaurus tutorial:
23
23
# npx create-docusaurus@latest docs classic
24
24
# but you can just use your existing Docusaurus site
0 commit comments