|
@@ -1,46 +1,27 @@
|
|
-# :fas fa-home fa-fw: Hell RDOC !
|
|
|
|
|
|
+# :fas fa-home fa-fw: Welcome to Red Hook !
|
|
|
|
|
|
-> Hell this is a fast and furious doc !! :smile:
|
|
|
|
|
|
+> ReDoc is a fast remote markdown documentation base on the awesome [docsify](https://docsify.js.org/) :smile:
|
|
|
|
|
|
-``simple line``
|
|
|
|
|
|
+## Okay but what the hell we added to Docsify?
|
|
|
|
|
|
- Quote of the hell
|
|
|
|
|
|
+Nothing but a few adjustments to increase this wonderful tool :
|
|
|
|
|
|
-```php
|
|
|
|
-echo "hello world"
|
|
|
|
-```
|
|
|
|
-
|
|
|
|
-![](_media/logo.png)
|
|
|
|
|
|
+* Upgraded Docker image to link an entiere remote repository to docsify
|
|
|
|
+* Remote Private repository managed with a project token
|
|
|
|
+* Adding common usefull plugins for developpers doc
|
|
|
|
|
|
-```java
|
|
|
|
-System.out.println("hello java")
|
|
|
|
-```
|
|
|
|
-
|
|
|
|
-You need to create a queue
|
|
|
|
|
|
+## How to install
|
|
|
|
|
|
|
|
+> Basically, just type a :
|
|
|
|
|
|
```terminal
|
|
```terminal
|
|
-$|npm run start
|
|
|
|
->|success|npm run start
|
|
|
|
->|npm run start
|
|
|
|
|
|
+$|docker run -p 3000:3000 -p 35729:35729 -e REFRESH_DELAY=1 -e REPOSITORY_URL=https://your-remote-markdow-doc.git rdoc
|
|
|
|
+>|Serving /My/doc/path/doc now.
|
|
|
|
+>|success|Listening at http://localhost:3000
|
|
```
|
|
```
|
|
|
|
|
|
-<!-- tabs:start -->
|
|
|
|
-
|
|
|
|
-#### **English**
|
|
|
|
-
|
|
|
|
-Hello!
|
|
|
|
-
|
|
|
|
-#### **French**
|
|
|
|
-
|
|
|
|
-Bonjour!
|
|
|
|
-
|
|
|
|
-#### **Italian**
|
|
|
|
|
|
+It's done ! You docsify is available at https://127.0.0.1:3000
|
|
|
|
|
|
-Ciao!
|
|
|
|
|
|
+If your a beginner with docsify and docker, please just go to the [getting start section](getting-started)
|
|
|
|
|
|
-<!-- tabs:end -->
|
|
|
|
|
|
|
|
-```html
|
|
|
|
-<span>it works</span>
|
|
|
|
-```
|
|
|