Skip to content

Commit

Permalink
Add docs to website
Browse files Browse the repository at this point in the history
  • Loading branch information
@Tapeline
Tapeline committed Oct 17, 2024
1 parent c61c69c commit 51bfa3e
Show file tree
Hide file tree
Showing 29 changed files with 560 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/en/HelpTOC.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"entities":{"pages":{"Quickstart":{"id":"Quickstart","title":"Quickstart","url":"quickstart.html","level":0,"tabIndex":0},"Execution-flow":{"id":"Execution-flow","title":"Execution flow","url":"execution-flow.html","level":0,"tabIndex":1},"Configuration-guide":{"id":"Configuration-guide","title":"Configuration guide","url":"configuration-guide.html","level":0,"tabIndex":2},"Command-line-usage":{"id":"Command-line-usage","title":"Command line usage","url":"command-line-usage.html","level":0,"tabIndex":3},"Builtin-tasks":{"id":"Builtin-tasks","title":"Builtin tasks","url":"builtin-tasks.html","level":0,"pages":["std-install","std-copy","std-cmd"],"tabIndex":4},"std-install":{"id":"std-install","title":"std.install","url":"std-install.html","level":1,"parentId":"Builtin-tasks","tabIndex":0},"std-copy":{"id":"std-copy","title":"std.copy","url":"std-copy.html","level":1,"parentId":"Builtin-tasks","tabIndex":1},"std-cmd":{"id":"std-cmd","title":"std.cmd","url":"std-cmd.html","level":1,"parentId":"Builtin-tasks","tabIndex":2}}},"topLevelIds":["Quickstart","Execution-flow","Configuration-guide","Command-line-usage","Builtin-tasks"]}
1 change: 1 addition & 0 deletions docs/en/Map.jhm
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?xml version='1.0' encoding='UTF-8'?><map version="2.0"><mapID target="Configuration-guide.topic" url="configuration-guide.html" default="no"/><mapID target="Quickstart.topic" url="quickstart.html" default="yes"/><mapID target="Command+line+usage" url="command-line-usage.html" default="no"/><mapID target="Configuration guide" url="configuration-guide.html" default="no"/><mapID target="Builtin-tasks.topic" url="builtin-tasks.html" default="no"/><mapID target="Builtin tasks" url="builtin-tasks.html" default="no"/><mapID target="std-copy" url="std-copy.html" default="no"/><mapID target="Command line usage" url="command-line-usage.html" default="no"/><mapID target="std.cmd" url="std-cmd.html" default="no"/><mapID target="Execution+flow" url="execution-flow.html" default="no"/><mapID target="std-install.topic" url="std-install.html" default="no"/><mapID target="Builtin-tasks" url="builtin-tasks.html" default="no"/><mapID target="std-cmd.topic" url="std-cmd.html" default="no"/><mapID target="Execution-flow.topic" url="execution-flow.html" default="no"/><mapID target="std-cmd" url="std-cmd.html" default="no"/><mapID target="Configuration-guide" url="configuration-guide.html" default="no"/><mapID target="std-install" url="std-install.html" default="no"/><mapID target="std.install" url="std-install.html" default="no"/><mapID target="Execution flow" url="execution-flow.html" default="no"/><mapID target="Command-line-usage" url="command-line-usage.html" default="no"/><mapID target="std.copy" url="std-copy.html" default="no"/><mapID target="std-copy.topic" url="std-copy.html" default="no"/><mapID target="Execution-flow" url="execution-flow.html" default="no"/><mapID target="Configuration+guide" url="configuration-guide.html" default="no"/><mapID target="Command-line-usage.topic" url="command-line-usage.html" default="no"/><mapID target="Builtin+tasks" url="builtin-tasks.html" default="no"/><mapID target="Quickstart" url="quickstart.html" default="yes"/></map>
16 changes: 16 additions & 0 deletions docs/en/builtin-tasks.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2024-10-18T01:23:15.4902796"><title>Builtin tasks | Embark (EN)</title><script type="application/json" id="virtual-toc-data">[]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b224/app.css" rel="stylesheet"><link rel="manifest" href="site.webmanifest"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Builtin tasks | Embark (EN)"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Embark (EN) Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/docs/en/1.0/builtin-tasks.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Builtin tasks | Embark (EN)"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/docs/en/1.0/builtin-tasks.html#webpage",
"url": "writerside-documentation/docs/en/1.0/builtin-tasks.html",
"name": "Builtin tasks | Embark (EN)",
"description": "",
"image": "",
"inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
"@type": "WebSite",
"@id": "writerside-documentation/docs/en/#website",
"url": "writerside-documentation/docs/en/",
"name": "Embark (EN) Help"
}</script><!-- End Schema.org --></head><body data-id="Builtin-tasks" data-main-title="Builtin tasks" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs=""><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Embark (EN) 1.0 Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Builtin-tasks" id="Builtin-tasks.topic">Builtin tasks</h1><p id="-5hc6yy_1">This section contains documentation on built-in task types</p><div class="last-modified">Last modified: 17 октября 2024</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="command-line-usage.html" class="navigation-links__prev">Command line usage</a><a href="std-install.html" class="navigation-links__next">std.install</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b224/app.js"></script></body></html>
16 changes: 16 additions & 0 deletions docs/en/command-line-usage.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2024-10-18T01:23:15.4902796"><title>Command line usage | Embark (EN)</title><script type="application/json" id="virtual-toc-data">[{"id":"user_commands","level":0,"title":"User commands","anchor":"#user_commands"},{"id":"dev_commands","level":0,"title":"Developer commands","anchor":"#dev_commands"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b224/app.css" rel="stylesheet"><link rel="manifest" href="site.webmanifest"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Command line usage | Embark (EN)"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Embark (EN) Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/docs/en/1.0/command-line-usage.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Command line usage | Embark (EN)"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/docs/en/1.0/command-line-usage.html#webpage",
"url": "writerside-documentation/docs/en/1.0/command-line-usage.html",
"name": "Command line usage | Embark (EN)",
"description": "",
"image": "",
"inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
"@type": "WebSite",
"@id": "writerside-documentation/docs/en/#website",
"url": "writerside-documentation/docs/en/",
"name": "Embark (EN) Help"
}</script><!-- End Schema.org --></head><body data-id="Command-line-usage" data-main-title="Command line usage" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs=""><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Embark (EN) 1.0 Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Command-line-usage" id="Command-line-usage.topic">Command line usage</h1><section class="chapter"><h2 id="user_commands" data-toc="user_commands">User commands</h2><dl id="-x4da9u_1" data-style="title-top"><dt id="-x4da9u_2" data-expandable="false">embark run &lt;playbook-file&gt; [--encoding]</dt><dd><p id="-x4da9u_3">Run a playbook. Examples:</p><ul class="list _bullet" id="-x4da9u_4"><li class="list__item" id="-x4da9u_5"><p><code class="code" id="-x4da9u_6">embark run playbook.yml</code></p></li><li class="list__item" id="-x4da9u_7"><p><code class="code" id="-x4da9u_8">embark run playbook.yml --encoding UTF-8</code></p></li></ul></dd></dl></section><section class="chapter"><h2 id="dev_commands" data-toc="dev_commands">Developer commands</h2><dl id="-x4da9u_9" data-style="title-top"><dt id="-x4da9u_10" data-expandable="false">embark dev_list_installs</dt><dd><p id="-x4da9u_11">Alias: <code class="code" id="-x4da9u_12">embark dli</code></p><p id="-x4da9u_13">List all installed application that Embark sees on your computer</p></dd><dt id="-x4da9u_14" data-expandable="false">embark dev_query_install &lt;name&gt; --publisher &lt;publisher&gt; [--version] [--ignore-version]</dt><dd><p id="-x4da9u_15">Alias: <code class="code" id="-x4da9u_16">embark dqi</code></p><p id="-x4da9u_17">Try to get specified installation from aforementioned list</p><ul class="list _bullet" id="-x4da9u_18"><li class="list__item" id="-x4da9u_19"><p><code class="code" id="-x4da9u_20">embark dqi &quot;LibreOffice .*&quot; --publisher &quot;The Document Foundation&quot; --ignore-version</code></p></li></ul></dd></dl></section><div class="last-modified">Last modified: 17 октября 2024</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="configuration-guide.html" class="navigation-links__prev">Configuration guide</a><a href="builtin-tasks.html" class="navigation-links__next">Builtin tasks</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b224/app.js"></script></body></html>
1 change: 1 addition & 0 deletions docs/en/config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"productVersion":"1.0","productId":"docs/en","stage":"release","downloadTitle":"Get Embark (EN)","keymaps":{},"searchMaxHits":75,"productName":"Embark (EN)"}
Loading

0 comments on commit 51bfa3e

Please sign in to comment.