github.com/vipernet-xyz/tm@v0.34.24/docs/DOCS_README.md (about)

     1  # Docs Build Workflow
     2  
     3  The documentation for Tendermint Core is hosted at:
     4  
     5  - <https://docs.tendermint.com/>
     6  
     7  built from the files in this (`/docs`) directory.
     8  
     9  ## How It Works
    10  
    11  There is a [GitHub Action](../.github/workflows/docs-deployment.yml) that is
    12  triggered by changes in the `/docs` directory on `main` as well as the branch of
    13  each major supported version (e.g. `v0.34.x`). Any updates to files in this
    14  directory on those branches will automatically trigger a website deployment.
    15  
    16  ## README
    17  
    18  The [README.md](./README.md) is also the landing page for the documentation on
    19  the website.
    20  
    21  ## Config.js
    22  
    23  The [config.js](./.vuepress/config.js) generates the sidebar and Table of
    24  Contents on the website docs. Note the use of relative links and the omission of
    25  file extensions. Additional features are available to improve the look of the
    26  sidebar.
    27  
    28  ## Links
    29  
    30  **NOTE:** Strongly consider the existing links - both within this directory and
    31  to the website docs - when moving or deleting files.
    32  
    33  Links to directories _MUST_ end in a `/`.
    34  
    35  Relative links should be used nearly everywhere, having discovered and weighed
    36  the following:
    37  
    38  ### Relative
    39  
    40  Where is the other file, relative to the current one?
    41  
    42  - works both on GitHub and for the VuePress build
    43  - confusing / annoying to have things like: `../../../../myfile.md`
    44  - requires more updates when files are re-shuffled
    45  
    46  ### Absolute
    47  
    48  Where is the other file, given the root of the repo?
    49  
    50  - works on GitHub, doesn't work for the VuePress build
    51  - this is much nicer: `/docs/hereitis/myfile.md`
    52  - if you move that file around, the links inside it are preserved (but not to it, of course)
    53  
    54  ### Full
    55  
    56  The full GitHub URL to a file or directory. Used occasionally when it makes sense
    57  to send users to the GitHub.
    58  
    59  ## Building Locally
    60  
    61  Make sure you are in the `docs` directory and run the following commands:
    62  
    63  ```bash
    64  rm -rf node_modules
    65  ```
    66  
    67  This command will remove old version of the visual theme and required packages.
    68  This step is optional.
    69  
    70  ```bash
    71  npm install
    72  ```
    73  
    74  Install the theme and all dependencies.
    75  
    76  ```bash
    77  npm run serve
    78  ```
    79  
    80  <!-- markdown-link-check-disable -->
    81  
    82  Run `pre` and `post` hooks and start a hot-reloading web-server. See output of
    83  this command for the URL (it is often <https://localhost:8080>).
    84  
    85  <!-- markdown-link-check-enable -->
    86  
    87  To build documentation as a static website run `npm run build`. You will find
    88  the website in `.vuepress/dist` directory.
    89  
    90  ## Search
    91  
    92  We are using [Algolia](https://www.algolia.com) to power full-text search. This
    93  uses a public API search-only key in the `config.js` as well as a
    94  [tendermint.json](https://github.com/algolia/docsearch-configs/blob/master/configs/tendermint.json)
    95  configuration file that we can update with PRs.
    96  
    97  ## Consistency
    98  
    99  Because the build processes are identical (as is the information contained
   100  herein), this file should be kept in sync as much as possible with its
   101  [counterpart in the Cosmos SDK
   102  repo](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md).