Commit 5c501ffa authored by Alexander Schilling's avatar Alexander Schilling
Browse files

update doc theme

parent 1aa7696e
Pipeline #236817069 passed with stage
in 2 minutes and 31 seconds
image: silentstorm/pandoc-mkdocs
before_script:
- pip install --upgrade pip
- pip install mkdocs-material
- pip install pymdown-extensions
- pip install markdown-blockdiag
- pip install markdown-include
- pip install mkdocs-mk2pdf-plugin
- pip install --upgrade pip
- pip install mkdocs-material
- pip install pymdown-extensions
- pip install markdown-blockdiag
- pip install markdown-include
- pip install mkdocs-with-pdf
pages:
stage: deploy
script:
- mkdocs build
- rm -rf public
- mv site public
artifacts:
paths:
- public
stage: deploy
script:
- mkdocs build
- rm -rf public
- mv site public
artifacts:
paths:
- public
......@@ -14,5 +14,23 @@
"email": "demo@alinex.de",
"password": "demo123"
}
}
},
"workbench.colorCustomizations": {
"activityBar.activeBackground": "#ff6433",
"activityBar.activeBorder": "#00ff3d",
"activityBar.background": "#ff6433",
"activityBar.foreground": "#15202b",
"activityBar.inactiveForeground": "#15202b99",
"activityBarBadge.background": "#00ff3d",
"activityBarBadge.foreground": "#15202b",
"statusBar.background": "#ff3d00",
"statusBar.foreground": "#e7e7e7",
"statusBarItem.hoverBackground": "#ff6433",
"tab.activeBorder": "#ff6433",
"titleBar.activeBackground": "#ff3d00",
"titleBar.activeForeground": "#e7e7e7",
"titleBar.inactiveBackground": "#ff3d0099",
"titleBar.inactiveForeground": "#e7e7e799"
},
"peacock.color": "#ff3d00"
}
\ No newline at end of file
......@@ -2,7 +2,7 @@
## Alinex Server
> Copyright 2018, 2019 Alexander Schilling (https://gitlab.com/alinex/node-server)
> Copyright 2018 - 2021 Alexander Schilling (https://gitlab.com/alinex/node-server)
!!! abstract "Apache License, Version 2.0"
......
......@@ -10,7 +10,7 @@ If you want to have an offline access to the documentation, feel free to downloa
## License
(C) Copyright 2018-2019 Alexander Schilling
(C) Copyright 2018 - 2019 Alexander Schilling
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
......
.TH "ALINEX" "" "November 2020" "" ""
.SH "NAME"
\fBAlinex\fR
.P
A pre\-configured, ready to use REST Server which can easily be used as backend to other services
or any frontend type\.
.SH Usage
.P
.RS 2
.nf
server [options]\.\.\.
.fi
.RE
.P
General Options:
.P
.RS 2
.nf
\-\-verbose, \-v run in verbose mode (multiple makes more verbose) [count]
\-\-quiet, \-q don't output header and footer [boolean]
\-\-nocolors, \-C turn of color output [boolean]
\-\-help, \-h Show help [boolean]
.fi
.RE
.P
You may use environment variables prefixed with 'SERVER_\|' to set any of
the options like 'SERVER_VERBOSE' to set the verbose level\.
.SH Documentation
.P
See the online documentation \fIhttps://alinex\.gitlabs\.io/node\-server\fR for more information and also
how to setup the schema and use of API\.
.SH License
.P
(C) Copyright 2018\-2019 Alexander Schilling
.P
Licensed under the Apache License, Version 2\.0 (the "License");
you may not use this file except in compliance with the License\.
You may obtain a copy of the License at
.QP
.P
http://www\.apache\.org/licenses/LICENSE\-2\.0
.
.P
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.
See the License for the specific language governing permissions and
limitations under the License\.
# Last Changes
## Version 1.0 (unreleased)
- update checkup and more packages
- update doc theme
## Version 1.0 (08.11.2020)
- completely replace checks with checkup
- FIND
......@@ -120,4 +123,4 @@ Not all functionality from 0.2.0 is available, but more will follow soon.
- REST server based on feathers.js
- initial version
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -34,8 +34,6 @@ Read all about the [alinex-server](https://alinex.gitlab.io/node-server) in the
- [Framework](app) - Adding applications
- [Architecture](dev) - System architecture and technologies
{!docs/assets/.stats.md!}
## Support
I don't give any paid support but you may create [GitLab Issues](https://gitlab.com/alinex/node-server/-/issues):
......@@ -47,4 +45,6 @@ I don't give any paid support but you may create [GitLab Issues](https://gitlab.
Please use for all of them the [GitLab Issues](https://gitlab.com/alinex/node-server/-/issues) which only requires you to register with a free account.
{!docs/assets/abbreviations.md!}
{!docs/assets/stats-pdf-license.txt!}
{!docs/assets/abbreviations.txt!}
## Statistics
The following statistics will give you a better understanding about it's complexity.
The documentation has 106 pages (in A4 PDF format) and contains 184648 characters.
And this package has 4332 lines of code.
The latest version in the repository is 1.0.0
It has a size of 3,24MiB in 297 files.
The development contains packages (resolved) and 6 of it are from the Alinex Project.
## Download Documentation
If you want to have an offline access to the documentation, feel free to download the 106 pages [PDF Documentation](alinex-server.pdf). But keep in mind that this is not as regularly updated as the online site, but at least on each release.
......@@ -19,6 +19,7 @@
*[ASCII]: American Standard Code for Information Interchange
*[ASP]: Active Server Pages / Application Service Provider
*[ATM]: Asynchronous Transfer Mode
*[AUR]: Arch User Repository
*[AuthIP]: Authenticated Internet Protocol
*[AuthN]: Authentication
*[AuthZ]: Authorization
......@@ -42,6 +43,7 @@
*[BPEL]: Business Process Execution Language
*[BPL]: Broadband over Power Lines
*[BPM]: Business Process Modeling
*[BPMN]: Business Process Model and Notation
*[BSD]: Berkeley Software Distribution
*[BSON]: Binary JavaScript Object Notation
*[BT]: BitTorrent / Bluetooth
......@@ -126,7 +128,6 @@
*[DSL]: Digital Subscriber Line
*[DTD]: Document Type Definition
*[DTP]: Desktop Publishing
*[DTP]: Desktop Publishing
*[DVD]: Digital Versatile Disc
*[DVI]: Digital Visual Interface
*[DVR]: Digital Video Recorder
......@@ -185,14 +186,17 @@
*[HDD]: Hard Disk Drive
*[HDLC]: High-level Data Link Control
*[HDMI]: High-Definition Multimedia Interface
*[HMAC]: Hash-based Message Authentication Code
*[HPC]: High-Performance Computing
*[HPFS]: High Performance File System
*[HSDPA]: High-Speed Downlink Packet Access
*[HSTS]: HTTP Strict Transport Security
*[HT]: Hyper Threading
*[HTML]: Hypertext Markup Language
*[HTTP]: Hypertext Transfer Protocol
*[HTTPS]: Hypertext Transfer Protocol Secure
*[I/O]: Input/output
*[IO]: Input/output
*[I18N]: Internationalization
*[IaaS]: Infrastructure as a Service
*[IANA]: Internet Assigned Number Authority
......@@ -273,6 +277,8 @@
*[LGPL]: Lesser General Public License
*[LIFO]: Last In First Out
*[LISP]: LISt Processing
*[LLDB]: Low Level Debugger
*[LLVM]: Low Level Virtual Machine
*[LOC]: Lines of Code
*[LRU]: Least Recently Used
*[LSB]: Linux Standard Base
......@@ -284,6 +290,7 @@
*[LVM]: Logical Volume Management
*[MAC]: Media Access Control
*[MBR]: Master Boot Record
*[MD5]: Message-Digest Algorithm
*[MDA]: Model-Driven Architecture
*[MDI]: Multiple Document Interface
*[MDM]: Master Data Management
......@@ -385,6 +392,8 @@
*[ROM]: Read Only Memory
*[RPC]: Remote Procedure Call
*[RPG]: Report Program Generator
*[RPM]: Red Hat Package Manager
*[RSA]: Public-key cryptosystem (Rivest–Shamir–Adleman)
*[RSS]: Resident Set Size (RAM)
*[RTC]: Real-Time Clock
*[RTF]: Rich Text Format
......@@ -408,6 +417,9 @@
*[SFTP]: SSH File Transfer Protocol
*[SGML]: Standard Generalized Markup Language
*[SHA]: Secure Hash Algorithm
*[SHA]: Secure Hash Algorithm
*[SHA256]: 256 bit Secure Hash Algorithm
*[SHA512]: 512 bit Secure Hash Algorithm
*[SIMM]: Single In-line Memory Module
*[SLA]: Service Level Agreement
*[SMB]: Server Message Block
......@@ -423,7 +435,6 @@
*[SQL]: Structured Query Language
*[SRAM]: Static random access memory
*[SSD]: Solid-State Drive
*[SSH]: Secure shell
*[SSH]: Secure Shell
*[SSI]: Server Side Includes
*[SSID]: Service set identifier (Wi-Fi)
......@@ -446,6 +457,7 @@
*[UDP]: User Datagram Protocol
*[UI]: User Interface
*[UML]: Unified Modeling Language
*[UML]: Unified Modeling Language
*[UMTS]: Universal Mobile Telecommunications System
*[UPS]: Uninterruptible Power Supply
*[URI]: Uniform Resource Identifier
......@@ -460,6 +472,7 @@
*[VLAN]: Virtual local area network
*[VLAN]: Virtual Local Area Network
*[VM]: Virtual Machine
*[VML]: Vector Markup Language
*[VOD]: Video On Demand
*[VoIP]: Voice over Internet Protocol
*[VPN]: Virtual private network
......@@ -476,12 +489,12 @@
*[WPF]: Windows Presentation Foundation
*[WSDL]: Web Services Description Language
*[WSFL]: Web Services Flow Language
*[WSL]: Windows-Subsystem for Linux
*[WWW]: World Wide Web
*[WYSIWYG]: What You See Is What You Get
*[XAML]: eXtensible Application Markup Language
*[XHTML]: eXtensible Hypertext Markup Language
*[XML]: eXtensible Markup Language
*[XML]: eXtensible Markup Language
*[XMMS]: X Multimedia System
*[XMPP]: eXtensible Messaging and Presence Protocol
*[XMS]: Extended Memory Specification
......@@ -490,7 +503,3 @@
*[XSS]: Cross-Site Scripting
*[YAML]: Yet Another Markup Language
*[ZIP]: ZIP file archive
*[RSA]: Public-key cryptosystem (Rivest–Shamir–Adleman)
*[MD5]: message-digest algorithm
*[SHA]: Secure Hash Algorithm
*[HMAC]: hash-based message authentication code
\ No newline at end of file
/* use image for grey color theme */
[data-md-color-primary='grey'] .md-tabs,
[data-md-color-primary='grey'] .md-header,
footer {
/* background-image: url('blue-tunnel.jpg');*/
background-image: url('default.jpg');
background-size: cover;
background-attachment: fixed;
@import url("https://fonts.googleapis.com/css2?family=Oswald&display=swap");
/* use image for color theme */
body,
.md-header,
.md-footer,
.md-tabs {
/* background-image: url('blue-tunnel.jpg');*/
background-image: url("default.jpg");
background-size: cover;
background-attachment: fixed;
}
.md-container,
.md-search__inner {
background-color: rgba(0, 0, 0, 0.9);
}
.md-footer-nav,
.md-footer-meta {
background: transparent;
background: transparent;
}
/* General style */
.md-typeset h1,
.md-tabs,
.md-header-nav__topic,
.md-sidebar {
font-family: "Oswald", sans-serif;
}
.md-tabs a {
font-size: 0.9rem;
}
.md-sidebar label {
font-size: 0.85rem;
}
.md-sidebar a {
font-size: 0.75rem;
margin-top: 0.4em;
}
.md-typeset h1 {
color: white;
}
.md-typeset__table th {
border-bottom: 2px solid darkorange;
font-weight: bold;
}
.md-typeset__table tr:nth-child(even) {
background: rgb(61, 61, 76);
}
.md-typeset table:not([class]) tr:nth-child(even):hover {
background-color: rgba(61, 61, 76, 0.035);
}
/* change link colors for grey theme */
.md-header-nav__button:hover {
opacity: 1;
color: darkorange;
transition: color 0.5s;
opacity: 1;
color: darkorange;
transition: color 0.5s;
}
[data-md-color-primary="grey"] .md-typeset a {
color: #00ade2;
}
[data-md-color-primary="grey"] .md-typeset a:hover {
color: darkorange;
}
[data-md-color-primary='grey'] .md-typeset a {
color: #cc3200;
.md-nav__item .md-nav__link--active {
color: white;
}
[data-md-color-primary='grey'] .md-typeset a:hover {
color: darkorange;
.md-sidebar label,
.md-nav__item--nested > .md-nav__link,
.md-sidebar a {
color: gray;
}
.md-nav__link:hover {
color: darkorange;
color: darkorange;
}
.md-nav__link[data-md-state="blur"] {
color: rgb(180, 180, 180);
}
.md-nav__item .md-nav__link--active {
color: white;
}
.md-footer-nav__link {
font-weight: bold;
font-weight: bold;
}
.md-footer-nav__link:hover {
opacity: 1;
color: darkorange;
transition: color 0.5s;
opacity: 1;
color: darkorange;
transition: color 0.5s;
}
a.headerlink {
color: gray;
}
/* display external links with icon */
div.md-content a[href^="http://"]:not([href*="alinex.gitlab.io"]):after,
div.md-content a[href^="https://"]:not([href*="alinex.gitlab.io"]):after,
div.md-content a[href^="//"]:not([href*="alinex.gitlab.io"]) {
content: '↗';
font-weight: normal;
font-style: normal;
font-size: 70%;
vertical-align: top;
display: inline-block;
text-decoration: none;
div.md-content a[href^="//"]:not([href*="alinex.gitlab.io"])
{
content: "↗";
font-weight: normal;
font-style: normal;
font-size: 70%;
vertical-align: top;
display: inline-block;
text-decoration: none;
}
/* attribute classes to be used via {: .class} */
.left {
/* left align with text float on the right */
float: left;
padding-right: 20px;
/* left align with text float on the right */
float: left;
padding-right: 20px;
}
.right {
/* right align with text float on the left */
float: right;
padding-left: 20px;
/* right align with text float on the left */
float: right;
padding-left: 20px;
}
.icon {
/* change image size */
width: 25%;
/* change image size */
width: 25%;
}
.border {
/* add drop shadow */
border: 1px solid #021a40;
-webkit-box-shadow: 0px 0px 18px 5px rgba(0, 0, 0, 0.5);
-moz-box-shadow: 0px 0px 18px 5px rgba(0, 0, 0, 0.5);
box-shadow: 0px 0px 18px 5px rgba(0, 0, 0, 0.5);
/* add drop shadow */
border: 1px solid #021a40;
-webkit-box-shadow: 0px 0px 18px 5px rgba(0, 0, 0, 0.5);
-moz-box-shadow: 0px 0px 18px 5px rgba(0, 0, 0, 0.5);
box-shadow: 0px 0px 18px 5px rgba(0, 0, 0, 0.5);
}
/* special use tags ==...== */
mark,
.md-typeset mark {
background-color: rgb(255, 253, 130);
color: black;
font-weight: bold;
}
/* blockdiag */
img[src*="%3Ctitle%3Eblockdiag%3C"] {
background-color: lightgray;
}
window.MathJax = {
tex: {
inlineMath: [["\\(", "\\)"]],
displayMath: [["\\[", "\\]"]],
processEscapes: true,
processEnvironments: true
},
options: {
ignoreHtmlClass: ".*|",
processHtmlClass: "arithmatex"
}
};
......@@ -27,4 +27,4 @@ The return value of data structures can be choosen with the accept header. But s
As shown above if the return data is a string it cannot get properties so you need to make an object, first. Use `text` as element name here because the formatter will automatically know to return the content only if mimetype is `text/*`.
The last part will define a property which will not show if the element keys are read but is accessible by the formatter.
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -249,4 +249,4 @@ logger.debug('Running...');
});
```
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -69,4 +69,4 @@ Hooks are like little middleware functions that allow you to run logic before an
Hooks compose well and help reuse code between your services.
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -33,4 +33,4 @@ import config from './config';
const host = config('server.host');
```
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -142,4 +142,4 @@ This folder contains the whole documentation as shown on this site as markdown.
The distribution folder will contain all the files which are needed for the production server. The structure within is the same as the folders described above. But in only with the modules needed for production and in case of a special project mixed with the addons and changes from core and the module.
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -235,4 +235,4 @@ This will add a avatar link (using gravatar) to the user record based on the ema
patch: [gravatar()]
}
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
......@@ -457,4 +457,4 @@ The server module uses the following names:
- `server:config` - configuration use
- `socket.io:*` - websocket transfer
{!docs/assets/abbreviations.md!}
{!docs/assets/abbreviations.txt!}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment