Skip to content
Permalink
Browse files

Fixed docs layout issues.

Replaced px with REMs in docs css.
Added new logo.
Added optimised svgs.
Added webpack dev server for testing docs.
Updated vscode launch and tasks config.
  • Loading branch information...
nero120 committed Oct 7, 2019
1 parent 3fea03f commit 7170743770e1218dd75f2af2e728d471d441da2f
@@ -20,12 +20,13 @@
"name": "Debug docs",
"type": "chrome",
"request": "launch",
"url": "http://127.0.0.1:8080",
"url": "http://127.0.0.1:9000",
"webRoot": "${workspaceFolder}/dist/docs",
"preLaunchTask": "serve",
"postDebugTask": "endTask",
"sourceMaps": true,
"smartStep": true,
"sourceMapPathOverrides": {
"webpack:///./src/docs/*": "${workspaceFolder}/src/docs/*"
"webpack:///./src/docs/index.ts": "${workspaceFolder}/src/docs/index.ts"
},
"runtimeArgs": [
"--remote-debugging-port=9222",
@@ -37,7 +38,11 @@
"type": "node",
"request": "launch",
"program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
"args": ["-r", "ts-node/register", "test/unit/*.test.ts"],
"args": [
"-r",
"ts-node/register",
"test/unit/*.test.ts"
],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"sourceMaps": true,
@@ -48,7 +53,11 @@
"type": "node",
"request": "launch",
"program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
"args": ["-r", "ts-node/register", "test/integration/*.test.ts"],
"args": [
"-r",
"ts-node/register",
"test/integration/*.test.ts"
],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"sourceMaps": true,
@@ -5,9 +5,8 @@
"tasks": [
{
"type": "npm",
"label": "build",
"script": "build",
"identifier": "build",
"label": "Build API",
"group": {
"kind": "build",
"isDefault": true
@@ -21,6 +20,38 @@
"problemMatcher": [
"$tsc"
]
},
{
"type": "npm",
"label": "serve",
"script": "serve",
"isBackground": true,
"presentation": {
"reveal": "always",
"panel": "shared"
},
"problemMatcher": {
"owner": "typescript",
"fileLocation": "relative",
"pattern": {
"regexp": "^([^\\s].*)\\((\\d+|\\,\\d+|\\d+,\\d+,\\d+,\\d+)\\):\\s+(error|warning|info)\\s+(TS\\d+)\\s*:\\s*(.*)$",
"file": 1,
"location": 2,
"severity": 3,
"code": 4,
"message": 5
},
"background": {
"activeOnStart": true,
"beginsPattern": ".",
"endsPattern": "Compiled",
}
}
},
{
"label": "endTask",
"type": "process",
"command": "${command:workbench.action.tasks.terminate}"
}
]
}

Large diffs are not rendered by default.

@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><svg version="1.1" viewBox="0 0 440.104 552.999" xmlns="http://www.w3.org/2000/svg"><path d="m125.48 540.64l-5.332 3.091-5.333 3.091-5.332 3.09-5.333 3.091-6.442-3.841-6.442-3.84-6.442-3.84-6.442-3.841-6.442-3.84-6.442-3.84-6.442-3.841 5.333-3.09 6.442 3.84 6.442 3.84 5.332-3.09 5.333-3.091 5.332-3.091 5.333-3.09 6.442 3.84 6.442 3.841 6.442 3.841 6.442 3.84 6.442 3.84-5.333 3.09zm-11.774-0.749l5.332-3.091-6.442-3.84-6.442-3.84-6.442-3.841-5.332 3.091-5.333 3.09-5.332 3.091 6.442 3.84 6.442 3.841 6.442 3.84 5.332-3.091 5.333-3.09z" fill="#0A323D"/><path d="m136.15 534.46l-6.442-3.841-6.442-3.84-6.442-3.841-6.442-3.84-6.442-3.84 5.333-3.091 5.333-3.091 5.333-3.09 5.333-3.091 6.442 3.841-5.333 3.09-5.333 3.091-5.333 3.09 6.442 3.841 6.442 3.84 6.442 3.84 6.442 3.841-5.333 3.091z" fill="#0A323D"/><path d="m184.14 506.64l-5.333 3.09-5.333 3.091-5.332 3.09-5.333 3.091-6.442-3.841-6.442-3.84-6.442-3.84-6.442-3.841-6.442-3.84 5.333-3.091 5.332-3.09 5.333-3.091 5.333-3.09 5.333-3.091 6.442 3.841 6.442 3.84 6.442 3.841 6.442 3.84 6.442 3.84-5.333 3.091zm-11.775-0.75l5.332-3.091-6.441-3.84-6.443-3.84-6.441-3.841-5.333 3.091-5.333 3.09-5.332 3.091 6.442 3.84 6.442 3.841 6.442 3.84 5.332-3.091 5.333-3.09z" fill="#0A323D"/><path d="m216.14 488.1l-5.333 3.09-5.332 3.09-5.333 3.091-5.333 3.091-6.441-3.841-6.443-3.84-6.441-3.84-6.443-3.841-6.441-3.84 5.332-3.091 6.442 3.841 6.442 3.84 6.442 3.841 6.442 3.84 5.332-3.091-6.441-3.84-6.443-3.84-6.441-3.841 5.332-3.091 6.442 3.841 6.442 3.841 6.442 3.84 5.333-3.091-6.442-3.84-6.442-3.841-6.442-3.84-6.442-3.84 5.332-3.091 6.442 3.84 6.442 3.841 6.442 3.84 6.442 3.84 6.442 3.841-5.332 3.091z" fill="#0A323D"/><path d="m248.13 469.56l-5.332 3.091-5.333 3.09-5.333 3.091-5.332 3.09-6.442-3.84 5.332-3.091 5.333-3.09 5.332-3.091 5.333-3.09-6.442-3.84-5.332 3.09-5.333 3.091-5.333 3.09-5.332 3.091-6.442-3.841-6.442-3.84-6.442-3.841 5.332-3.09 5.333-3.091 5.332-3.09 5.333-3.091 5.333-3.09 6.441 3.84-5.332 3.091-5.332 3.09-5.333 3.091-5.333 3.09 6.442 3.841 5.333-3.091 5.332-3.09 5.333-3.091 5.333-3.09 6.441 3.84 6.443 3.84 6.441 3.841-5.332 3.09z" fill="#0A323D"/><path d="m273.68 447.18l5.333-3.091 6.442 3.84-5.333 3.091-5.332 3.091-5.333 3.09-5.332 3.091-5.333 3.09-6.442-3.84-6.442-3.84-6.442-3.841-6.442-3.84-6.442-3.841 5.333-3.09 5.332-3.091 5.333-3.09 5.332-3.091 5.333-3.091 6.442 3.841 6.442 3.841 6.442 3.84-5.333 3.091-5.332 3.09-5.333 3.091-5.332 3.09 6.442 3.84 5.332-3.09 5.333-3.091 5.332-3.09zm-18.216-4.59l5.332-3.091-6.442-3.84-5.332 3.09-5.333 3.091-5.332 3.09 6.442 3.841 5.332-3.091 5.333-3.09z" fill="#0A323D"/><path d="m290.79 444.84l-6.441-3.84-6.443-3.84-6.441-3.841-6.443-3.841-6.441-3.84 5.332-3.09 5.332-3.091 5.333-3.091 5.333-3.09 6.441 3.84-5.332 3.091-5.332 3.09-5.333 3.091 6.442 3.84 6.442 3.841 6.442 3.84 6.442 3.841-5.333 3.09z" fill="#0A323D"/><path d="m338.78 417.02l-5.332 3.091-5.333 3.09-5.332 3.091-5.333 3.09-6.442-3.84 5.333-3.091 5.332-3.09 5.333-3.091 5.332-3.09-6.442-3.84-5.332 3.09-5.333 3.091-5.332 3.09-5.333 3.091-6.442-3.841-6.442-3.84-6.442-3.841 5.333-3.09 5.332-3.091 5.333-3.09 5.332-3.091 5.333-3.09 6.442 3.84-5.333 3.091-5.332 3.09-5.333 3.091-5.332 3.09 6.442 3.841 5.332-3.091 5.333-3.09 5.332-3.091 5.333-3.09 6.442 3.84 6.442 3.84 6.442 3.841-5.333 3.09z" fill="#0A323D"/><path d="m383.66 406.16l-5.333 3.091-5.333 3.091-5.332 3.09-5.332 3.091-6.443-3.84 5.333-3.091 5.333-3.09 5.332-3.091 5.333-3.091-6.441-3.84-5.333 3.09-5.332 3.091-5.333 3.091-5.333 3.09-6.441-3.84-6.443-3.84-6.441-3.841-6.443-3.84-6.441-3.841 5.332-3.09 6.442 3.84 6.442 3.841 6.442 3.84 6.442 3.84 5.332-3.09 5.333-3.091 5.333-3.09-6.442-3.84-6.442-3.841-6.442-3.841-6.442-3.84 5.332-3.09 6.442 3.84 6.442 3.84 6.442 3.841 6.442 3.84 6.442 3.841 6.441 3.84 6.442 3.84-5.332 3.09z" fill="#0A323D"/><path d="m402.78 379.94l-6.442-3.841-6.442-3.84-6.442-3.84-6.442-3.841-5.332 3.091-5.333 3.09-5.333 3.091 6.442 3.84 6.442 3.841 6.442 3.84 6.442 3.84-5.332 3.091-6.442-3.841-6.442-3.84-6.442-3.84-6.442-3.841-6.442-3.84 5.332-3.091 5.333-3.09 5.332-3.091 5.333-3.09 5.333-3.091 6.441 3.841 6.443 3.84 6.441 3.841 6.443 3.84 6.441 3.84-5.332 3.091z" fill="#0A323D"/><path d="m415.44 349.88l-6.442-3.841-5.332 3.091-5.333 3.09-5.332 3.091 6.441 3.84 6.443 3.841 6.441 3.84 5.333-3.091 5.333-3.09 5.332-3.091-6.442-3.84 5.333-3.09 6.442 3.84 6.442 3.84-5.333 3.091-5.332 3.09-5.333 3.091-5.332 3.09-5.333 3.091-6.442-3.841-6.442-3.84-6.442-3.84-6.442-3.841-6.442-3.84 5.332-3.091 5.333-3.09 5.333-3.091 5.332-3.09 5.333-3.091 6.442 3.841 6.442 3.84-5.333 3.091z" fill="#0A323D"/><polygon points="306.04 147.19 204.53 88.193 204.36 29.494 305.88 88.487" fill="#0A323D"/><polygon points="306.71 382.01 205.19 323.02 205.03 264.32 306.54 323.31" fill="#0A323D"/><polygon points="255.46 352.81 153.94 293.81 153.78 235.11 255.29 294.11" fill="#0A323D"/><polygon points="255.12 235.41 153.61 176.41 153.44 117.69 254.96 176.68" fill="#0A323D"/><polygon points="204.21 323.6 102.69 264.61 102.52 205.91 204.04 264.9" fill="#0A323D"/><polygon points="153.29 411.79 51.773 352.8 51.606 294.1 153.12 353.09" fill="#0A323D"/><polygon points="152.96 294.39 51.44 235.4 51.274 176.67 152.79 235.67" fill="#0A323D"/><polygon points="101.68 265.18 0.166 206.18 0 147.48 101.52 206.48" fill="#0A323D"/><polygon points="102.35 500 0.832 441.01 0.666 382.31 102.18 441.3" fill="#0A323D"/><polygon points="305.88 88.487 204.36 29.494 255.44 0 356.96 58.994" fill="#267D91"/><polygon points="306.54 323.31 205.03 264.32 256.11 234.82 357.62 293.82" fill="#267D91"/><polygon points="255.29 294.11 153.78 235.11 204.86 205.62 306.37 264.61" fill="#267D91"/><polygon points="254.96 176.68 153.44 117.69 204.53 88.193 306.04 147.19" fill="#267D91"/><polygon points="204.04 264.9 102.52 205.91 153.61 176.41 255.12 235.41" fill="#267D91"/><polygon points="153.12 353.09 51.606 294.1 102.69 264.61 204.21 323.6" fill="#267D91"/><polygon points="152.79 235.67 51.274 176.67 102.36 147.18 203.87 206.17" fill="#267D91"/><polygon points="101.52 206.48 0 147.48 51.107 117.97 152.62 176.97" fill="#267D91"/><polygon points="102.18 441.3 0.666 382.31 51.773 352.8 153.29 411.79" fill="#267D91"/><polygon points="356.96 58.994 357.12 117.69 306.04 147.19 305.88 88.487" fill="#71D2E2"/><polygon points="357.62 293.82 357.79 352.52 306.71 382.01 306.54 323.31" fill="#71D2E2"/><polygon points="306.37 264.61 306.54 323.31 255.46 352.81 255.29 294.11" fill="#71D2E2"/><polygon points="306.04 147.19 306.21 205.91 255.12 235.41 254.96 176.68" fill="#71D2E2"/><polygon points="255.12 235.41 255.29 294.11 204.21 323.6 204.04 264.9" fill="#71D2E2"/><polygon points="204.21 323.6 204.37 382.3 153.29 411.79 153.12 353.09" fill="#71D2E2"/><polygon points="203.87 206.17 204.04 264.9 152.96 294.39 152.79 235.67" fill="#71D2E2"/><polygon points="152.62 176.97 152.79 235.67 101.68 265.18 101.52 206.48" fill="#71D2E2"/><polygon points="153.29 411.79 153.45 470.49 102.35 500 102.18 441.3" fill="#71D2E2"/></svg>

Large diffs are not rendered by default.

BIN -1.32 KB (74%) dist/docs/icon-128.png
Binary file not shown.
@@ -1,4 +1,4 @@
<!DOCTYPE html> <html lang=en> <head> <meta charset=utf-8 /> <meta name=viewport content="width=device-width,initial-scale=1"/> <meta name=robots content=noindex /> <title>xBrowserSync API</title> <link rel=icon type=image/png href=./icon-128.png sizes=128x128> <link href="styles.css" rel="stylesheet"></head> <body id=home class=index> <div class=bg-main> <div class=bg-main-img></div> </div> <button type=button class=nav-menu-button> <span class=hamburger aria-hidden=true></span> <span class=sr-only>Menu</span> </button> <nav id=mainNav class="navbar navbar-expand-md navbar-default navbar-fixed-top navbar-custom affix"> <div class=container> <div class="collapse navbar-collapse" id=navbar> <ul class=navbar-nav> <li class=nav-item> <a class=nav-link href=#home>Home</a> </li> <li class=nav-item> <a class=nav-link href=#status>Status</a> </li> <li class=nav-item> <a class=nav-link href=#bookmarks>Bookmarks</a> </li> <li class=nav-item> <a class=nav-link href=#serviceinfo>Service Information</a> </li> </ul> </div> </div> </nav> <header> <div class=container> <div class=row> <div class="col-md-4 offset-md-2"> <h1>xBrowserSync</h1> </div> <div class="title col-md-6"> <h2>API service info</h2> </div> </div> </div> </header> <section id=status class=dark> <div class=container> <div class=row> <div class="serviceinfo col-lg-8 offset-lg-2"> <span> <strong>Status:</strong> <span id=currentstatus></span> </span> <span> <strong>Version:</strong> <span id=version></span> </span> </div> <div class="col-lg-8 offset-lg-2"> <div id=servermessage></div> </div> </div> <div class=row> <div class="col-lg-8 offset-lg-2"> <p>This xBrowserSync service provides a REST API that xBrowserSync clients can sync to. The available API methods are listed below.</p> <p>For more information visit the <a href=https://www.xbrowsersync.org/ >xBrowserSync website</a> or check out the <a href=https://github.com/xbrowsersync/api>API GitHub repo</a>.</p> </div> </div> </div> </section> <section id=bookmarks> <div class=container> <div class=panel> <h3>Bookmarks</h3> <div class=header> <h4>Create bookmarks</h4> <div> <span class="label label-warning">Post</span> <code>/bookmarks</code> </div> </div> <p>Creates a new (empty) bookmark sync and returns the corresponding ID.</p> <div class=example> <p>Post body example:</p> <pre><code>{
<!DOCTYPE html> <html lang=en> <head> <meta charset=utf-8 /> <meta name=viewport content="width=device-width,initial-scale=1"/> <meta name=robots content=noindex /> <title>xBrowserSync API</title> <link rel=icon type=image/png href=./icon-128.png sizes=128x128> <link href="styles.css" rel="stylesheet"></head> <body id=home class=index> <div class=background> <div class=background-img></div> </div> <button type=button class=nav-menu-button> <span class=hamburger aria-hidden=true></span> <span class=sr-only>Menu</span> </button> <nav id=mainNav class="navbar navbar-expand-md navbar-default navbar-fixed-top navbar-custom affix"> <div class=container> <div class="collapse navbar-collapse" id=navbar> <ul class=navbar-nav> <li class=nav-item> <a class=nav-link href=#home>Home</a> </li> <li class=nav-item> <a class=nav-link href=#status>Status</a> </li> <li class=nav-item> <a class=nav-link href=#bookmarks>Bookmarks</a> </li> <li class=nav-item> <a class=nav-link href=#serviceinfo>Service Information</a> </li> </ul> </div> </div> </nav> <header> <div class=container> <div class=row> <div class="col-md-4 offset-md-2"> <h1>xBrowserSync</h1> </div> <div class="title col-md-6"> <h2>API service info</h2> </div> </div> </div> </header> <section id=status class=dark> <div class=container> <div class=row> <div class="serviceinfo offline"> <div class=status> <span> <strong>Status:</strong> <span id=currentstatus></span> </span> <span class=version> <strong>Version:</strong> <span id=version></span> </span> </div> <div id=servermessage></div> </div> </div> <div class=row> <div class="col-lg-8 offset-lg-2"> <p>This xBrowserSync service provides a REST API that xBrowserSync clients can sync to. The available API methods are listed below.</p> <p>For more information visit the <a href=https://www.xbrowsersync.org/ >xBrowserSync website</a> or check out the <a href=https://github.com/xbrowsersync/api>API GitHub repo</a>.</p> </div> </div> </div> </section> <section id=bookmarks> <div class=container> <div class=panel> <h3>Bookmarks</h3> <div class=header> <h4>Create bookmarks</h4> <div> <span class="label label-warning">Post</span> <code>/bookmarks</code> </div> </div> <p>Creates a new (empty) bookmark sync and returns the corresponding ID.</p> <div class=example> <p>Post body example:</p> <pre><code>{
"version":"1.0.0"
}</code></pre> <ul> <li> <strong>version:</strong> Version number of the xBrowserSync client used to create the sync.</li> </ul> <p>Response example:</p> <pre><code>{
"id":"52758cb942814faa9ab255208025ae59",

Large diffs are not rendered by default.

Large diffs are not rendered by default.

0 comments on commit 7170743

Please sign in to comment.
You can’t perform that action at this time.