diff --git a/README.md b/README.md index 2d8f0f3..4c7935a 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ It has a design that i was developing and using all the time. Hope you will enjoy. Free to use. +## Complete Documentation + +[Click here for complete documentation](doc/index.html) + ## Installation and first use ### Install Project Manager @@ -32,27 +36,27 @@ In order to use the project manager you have to execute it once project-manager -![](.images/install-project-manager.png) +![](doc/img/install-project-manager.png) ### Create your first project project-manager create-project domain.de www.domain.de domain -![](.images/create-project.png) +![](doc/img/create-project.png) ### Workspace directories -![](.images/workspace-created-directories.png) +![](doc/img/workspace-created-directories.png) ### Configure your project -![](.images/configure-your-project.png) +![](doc/img/configure-your-project.png) ### Add a new Subdomain -![](.images/adding-subdomain-project.png) +![](doc/img/adding-subdomain-project.png) -![](.images/directories-with-subdomain.png) +![](doc/img/directories-with-subdomain.png) ## Commando reference diff --git a/doc/content/main/commando-reference.md b/doc/content/main/commando-reference.md new file mode 100644 index 0000000..c13a2c4 --- /dev/null +++ b/doc/content/main/commando-reference.md @@ -0,0 +1,18 @@ +## Commando reference + +### The help command + + project-manager --help + project-manager --help command + project-manager --help plugin:command + +### Print lists + + project-manager --list-commands + project-manager --list-commands plugin + project-manager --list-plugins + +### The usage + + project-manager command + project-manager plugin:command \ No newline at end of file diff --git a/doc/content/main/create-project.md b/doc/content/main/create-project.md new file mode 100644 index 0000000..1ddba8c --- /dev/null +++ b/doc/content/main/create-project.md @@ -0,0 +1,24 @@ +## Create Project + + project-manager create-project domain.de www.domain.de domain + +![](img/create-project.png) +![](../../img/create-project.png) + +### Workspace directories + +![](img/workspace-created-directories.png) +![](../../img/workspace-created-directories.png) + +### Configure your project + +![](img/configure-your-project.png) +![](../../img/configure-your-project.png) + +### Add a new Subdomain + +![](img/adding-subdomain-project.png) +![](../../img/adding-subdomain-project.png) + +![](img/directories-with-subdomain.png) +![](../../img/directories-with-subdomain.png) \ No newline at end of file diff --git a/doc/content/main/install.md b/doc/content/main/install.md new file mode 100644 index 0000000..2175f26 --- /dev/null +++ b/doc/content/main/install.md @@ -0,0 +1,29 @@ +## Installation + +### Install Project Manager + +In order to get you startet create first a folder, eg: + + ~/Workspaces + +Go into this folder an install the Sumedia Project Manager + + cd ~/Workspaces + git clone https://git-sumedia-webdesign.de/sumedia-webdesign/project-manager.git .project_manager + +You can setup the ```project-manager``` to your path or make a link to your bin + + sudo ln -s /home/name/Workspaces/.project_manager/bin/project-manager /usr/local/bin/project-manager + +Now you can execute it the first time and check the configuration of your Project Manager + + project-manager + +### Setup + +In order to use the project manager you have to execute it once + + project-manager + +![](img/install-project-manager.png) +![](../../img/install-project-manager.png) \ No newline at end of file diff --git a/doc/css/base.css b/doc/css/base.css new file mode 100644 index 0000000..92e278f --- /dev/null +++ b/doc/css/base.css @@ -0,0 +1,68 @@ +@import "../lib/font-awesome-4.7.0/css/font-awesome.min.css"; + +body { + margin: 0; + background-color: #333; + color: #fff; + font-family: arial, helvetica, sans-serif; +} + +a { + color: #fc0; +} + +#menu { + background-color: #373737; + border: 1px solid #494949; + height: 45px; + width: 100%; + top: 0; + position: fixed; +} + +#menu ul, +#menu li { + margin: 0; + padding: 0; + list-style-type: none; +} + +#menu > ul > li { + float: left; + margin-left: 30px; + padding: 15px; +} + +#menu > ul > li > ul { + display: none; +} + +#menu > ul > li:hover > ul { + position:absolute; + display:block; + border: 1px solid #494949; + background-color: #373737; + padding: 15px; +} + +#menu > ul > li > ul > li { + line-height: 1.8em; +} + +#menu > ul > li > ul > li > a:before { + display: inline-block; + font-family: FontAwesome; + content: "\f18e"; + text-decoration: none; + margin-right: 8px; + font-size: 14px; +} + +#title { + margin-top: 70px; + margin: 70px 40px 0; +} + +#page { + margin: 0 40px 50px; +} \ No newline at end of file diff --git a/.images/adding-subdomain-project.png b/doc/img/adding-subdomain-project.png similarity index 100% rename from .images/adding-subdomain-project.png rename to doc/img/adding-subdomain-project.png diff --git a/.images/configure-your-project.png b/doc/img/configure-your-project.png similarity index 100% rename from .images/configure-your-project.png rename to doc/img/configure-your-project.png diff --git a/.images/create-project.png b/doc/img/create-project.png similarity index 100% rename from .images/create-project.png rename to doc/img/create-project.png diff --git a/.images/directories-with-subdomain.png b/doc/img/directories-with-subdomain.png similarity index 100% rename from .images/directories-with-subdomain.png rename to doc/img/directories-with-subdomain.png diff --git a/.images/install-project-manager.png b/doc/img/install-project-manager.png similarity index 100% rename from .images/install-project-manager.png rename to doc/img/install-project-manager.png diff --git a/.images/workspace-created-directories.png b/doc/img/workspace-created-directories.png similarity index 100% rename from .images/workspace-created-directories.png rename to doc/img/workspace-created-directories.png diff --git a/doc/include/menu.html b/doc/include/menu.html new file mode 100644 index 0000000..e8c232a --- /dev/null +++ b/doc/include/menu.html @@ -0,0 +1,10 @@ +