idleman 7 months ago
parent
commit
e58fdd7461
9 changed files with 116 additions and 53 deletions
  1. 14 33
      README.md
  2. 3 17
      _glossary.md
  3. 1 0
      _nav.md
  4. 2 1
      _sidebar.md
  5. 0 2
      getting-started.md
  6. 1 0
      index.html
  7. 17 0
      plugin.js
  8. 76 0
      special-syntax.md
  9. 2 0
      usage.md

+ 14 - 33
README.md

@@ -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
-$|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>
-```

+ 3 - 17
_glossary.md

@@ -2,30 +2,16 @@
 
 ## A
 
-### Admiral
-
-A commander of a fleet or naval squadron, or a naval officer of very high rank.
-
 ## B - I
 
 Nothing here....
 
-## J
-
-### Jack Rackham
-
-Jack Rackham was a gentleman pirate with flamboyant fashion sense and a way with female pirates who were dressed like men– notably, Anne Bonny and Mary Read.
+## D
 
-## Q
+### Docker
 
-### Queue
-
-A type of destination
+Docker is a container system
 
 ## K - X
 
 ## Y
-
-### Yellow Jack
-
-Another term for yellow flag

+ 1 - 0
_nav.md

@@ -2,3 +2,4 @@
 * **Getting started**
 	* [Installation](install.md "Install")
 	* [Getting started](getting-started.md "The greatest guide in the world")
+	* [Special syntax](special-syntax.md)

+ 2 - 1
_sidebar.md

@@ -1,4 +1,5 @@
 * [Home](/)
 * **Getting started**
 	* [Installation](install.md "Install")
-	* [Getting started](getting-started.md "The greatest guide in the world")
+	* [Usage](usage.md)
+	* [Special syntax](special-syntax.md)

+ 0 - 2
getting-started.md

@@ -1,2 +0,0 @@
-# Getting started
-

+ 1 - 0
index.html

@@ -40,6 +40,7 @@
   <!-- Docsify v4 -->
   <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
   <script src="./docsify-glossary.min.js"></script>
+  <script src="./plugin.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-java.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>

+ 17 - 0
plugin.js

@@ -0,0 +1,17 @@
+(function () {
+  var myPlugin = function (hook, vm) {
+    // Invoked one time when the docsify instance has mounted on the DOM
+    hook.mounted(function () {
+      console.log(window.Docsify,vm);
+    });
+
+    hook.afterEach(function (html) {
+        return html + 'Powered by redok';
+    });
+
+  };
+
+  // Add plugin to docsify's plugin array
+  $docsify = $docsify || {};
+  $docsify.plugins = [].concat($docsify.plugins || [], myPlugin);
+})();

+ 76 - 0
special-syntax.md

@@ -0,0 +1,76 @@
+# Installed plugins
+
+## Terminal like
+
+> markdown
+
+	```terminal
+	$|docker run -p 3000:3000 -p 35729:35729 -e REFRESH_DELAY=1 -e REPOSITORY_URL=https://your-remote-markdow-doc.git rdoc
+	>|docker run -p 3000:3000 -p 35729:35729 -e REFRESH_DELAY=1 -e REPOSITORY_URL=https://your-remote-markdow-doc.git rdoc
+	```
+
+> render
+
+```terminal
+$|docker run -p 3000:3000 -p 35729:35729 -e REFRESH_DELAY=1 -e REPOSITORY_URL=https://your-remote-markdow-doc.git rdoc
+>|docker run -p 3000:3000 -p 35729:35729 -e REFRESH_DELAY=1 -e REPOSITORY_URL=https://your-remote-markdow-doc.git rdoc
+```
+
+## Langages 
+
+> markdown
+
+	```php
+	$jude = 'Jude';
+	echo 'Hey '.$jude;
+	```
+
+> render
+
+```php
+$jude = 'Jude';
+echo 'Hey '.$jude;
+```
+
+
+## Image zoom
+
+> render
+
+![](_media/logo.png)
+
+## Integration glossary
+
+Some words as a docker can be added to the ``_glossary.md`` file to be auto linked/described in any page 
+
+
+## Tab system
+
+> markdown
+
+	Surround below black  by html comment tabs:start  and  tabs:end 
+	#### **English**
+	Hello!
+	#### **French**
+	Bonjour!
+	#### **Italian**
+	Ciao!
+	
+
+> render
+
+<!-- tabs:start -->
+
+#### **English**
+
+Hello!
+
+#### **French**
+
+Bonjour!
+
+#### **Italian**
+
+Ciao!
+
+<!-- tabs:end -->

+ 2 - 0
usage.md

@@ -0,0 +1,2 @@
+# How to use
+