Skip to content

Commit

Permalink
hide README from sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
tradersnow222 committed Nov 29, 2024
1 parent ccf5c69 commit 544d655
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
54 changes: 54 additions & 0 deletions docs/_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
sidebar_exclude: true
---

<div align="center">
<img src="https://github.com/1inch/farming/blob/master/.github/1inch_github_w.svg#gh-light-mode-only" />
<img src="https://github.com/1inch/farming/blob/master/.github/1inch_github_b.svg#gh-dark-mode-only" />
</div>

# Welcome to the 1inch Community & Governance Docs!

This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

This folder contains submodules that you need to pull `git submodule update --recursive`

## Running the docs site locally

### Install base dependencies

```
$ pnpm install
```

### Run local environment

```
$ pnpm start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ pnpm build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### General info

You can see `warning` in time `pnpm install` - it's okey

File `docs\limit-order-protocol\smart-contract\_category_.json` changed after `pnpm install`. Discard changes in this file before execute some other commands

Search doesn't work in `pnpm start`.
For check working of the search you need:
- `pnpm build`
- `pnpm serve`

If you got some error check that you does all in accordiance with README.
After that remove `pnpm-lock.yaml` (`package-lock.json`), `node_modules` and `build` (if there is one). And try again.
Also check node.js version. All correct worked with node version 18.2.0

2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
*/

module.exports = {
// Automatically generate a sidebar based on the folder structure in the docs directory
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
};

0 comments on commit 544d655

Please sign in to comment.