gnosis/lighthouse
1
0
Fork 0
mirror of https://github.com/sigp/lighthouse.git synced 2026-04-29 02:33:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Markdown linter (#5494)

Browse Source 
* linter

* Add markdown linter

* add env

* only check markdown

* Add token

* Update .github/workflows/test-suite.yml

* Markdown linter

* Exit code

* Update script

* rename

* mdlint

* Add an empty line after end of file

* Testing disable

* add text

* update mdlint.sh

* ori validator inclusion

* Add config yml file

* Remove MD041 and fix advanced-datadir file

* FIx validator inclusion file conflict

* Merge branch 'unstable' into markdown-linter

* change files

* Merge branch 'markdown-linter' of https://github.com/chong-he/lighthouse into markdown-linter

* mdlint

* Remove MD025

* Remove MD036

* Remove MD045

* Removr MD001

* Set MD028 to false

* Remove MD024

* Remove MD055

* Remove MD029

* Remove MD040

* Set MD040 to false

* Set MD033 to false

* Set MD013 to false

* Rearrange yml file

* Update mdlint.sh and test

* Test remove fix

* Test with fix

* Test with space

* Fix summary indentation

* Test mdlint.sh

* Update mdlint.sh

* Test

* Update

* Test fix

* Test again

* Fix

* merge into check-code

* Update scripts/mdlint.sh

Co-authored-by: Mac L <mjladson@pm.me>

* Update scripts/mdlint.sh

Co-authored-by: Mac L <mjladson@pm.me>

* Remove set -e

* Add comment

* Merge pull request #7 from chong-he/unstable

Merge unstable to markdown branch

* mdlint

* Merge branch 'unstable' into markdown-linter

* mdlint
This commit is contained in:
chonghe
2024-05-24 10:45:19 +08:00
committed by GitHub
parent 7073242ccc
commit 3070cb7c39
68 changed files with 720 additions and 637 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
book/src/ui-installation.md
View File

@@ -3,6 +3,7 @@
Siren runs on Linux, MacOS and Windows.
## Version Requirement
The Siren app requires Lighthouse v3.5.1 or higher to function properly. These versions can be found on the [releases](https://github.com/sigp/lighthouse/releases) page of the Lighthouse repository.
## Pre-Built Electron Packages
@@ -26,26 +27,26 @@ The electron app can be built from source by first cloning the repository and
entering the directory:
```
$ git clone https://github.com/sigp/siren.git
$ cd siren
git clone https://github.com/sigp/siren.git
cd siren
```
Once cloned, the electron app can be built and ran via the Makefile by:
```
$ make
make
```
alternatively it can be built via:
```
$ yarn
yarn
```
Once completed successfully the electron app can be run via:
```
$ yarn dev
yarn dev
```
### Running In The Browser
@@ -59,19 +60,22 @@ production-grade web-server to host the application.
`docker` is required to be installed with the service running.
The docker image can be built and run via the Makefile by running:
```
$ make docker
make docker
```
Alternatively, to run with Docker, the image needs to be built. From the repository directory
run:
```
$ docker build -t siren .
docker build -t siren .
```
Then to run the image:
```
$ docker run --rm -ti --name siren -p 80:80 siren
docker run --rm -ti --name siren -p 80:80 siren
```
This will open port 80 and allow your browser to connect. You can choose
@@ -83,20 +87,24 @@ To view Siren, simply go to `http://localhost` in your web browser.
#### Development Server
A development server can also be built which will expose a local port 3000 via:
```
$ yarn start
yarn start
```
Once executed, you can direct your web browser to the following URL to interact
with the app:
```
http://localhost:3000
```
A production version of the app can be built via
```
$ yarn build
yarn build
```
and then further hosted via a production web server.
### Known Issues