Skip to content

Commit 086fb72

Browse files
author
github-actions
committed
auto: docs: Use workaround to h-scroll large code block
SourceCommit: emacs-eask/cli@89167e8
1 parent f9da584 commit 086fb72

File tree

14 files changed

+171
-171
lines changed

14 files changed

+171
-171
lines changed

Development-API/index.html

Lines changed: 30 additions & 30 deletions
Large diffs are not rendered by default.

FAQ/index.html

Lines changed: 24 additions & 24 deletions
Large diffs are not rendered by default.

Getting-Started/Basic-Usage/index.html

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -134,24 +134,24 @@
134134
</span></span></code></pre></div><p>Notice the subcommand can be nested:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask clean workspace <span class=c1># Deletes your `.eask` folder</span>
135135
</span></span></code></pre></div><p>Pass in option <code>--help</code> to look up more information regarding the command you
136136
are using:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask clean --help
137-
</span></span></code></pre></div><p>The output, and it shows there are 7 subcommands supported:</p><pre tabindex=0><code>Delete various files produced during building
138-
139-
Usage: eask clean &lt;type&gt; [options..]
140-
141-
Commands:
142-
clean all Do all cleaning tasks [aliases: everything]
143-
clean autoloads Remove generated autoloads file
144-
clean dist [destination] Delete dist subdirectory [aliases: distribution]
145-
clean elc Remove byte compiled files generated by eask compile
146-
clean log-file Remove all generated log files
147-
clean pkg-file Remove generated pkg-file
148-
clean workspace Clean up .eask directory [aliases: .eask]
149-
150-
Positionals:
151-
&lt;type&gt; type of the cleaning task
152-
153-
...
154-
</code></pre><p>Here is a list of known nested subcommands:</p><ul><li>eask create</li><li>eask clean</li><li>eask generate</li><li>eask generate workflow</li><li>eask link</li><li>eask lint</li><li>eask run</li><li>eask source</li><li>eask test</li></ul><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-knowing-your-elpa-directory>📌 Knowing your <code>elpa</code> directory</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Basic-Usage/#-knowing-your-elpa-directory class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📌 Knowing your elpa directory" aria-label="Anchor to: 📌 Knowing your elpa directory" href=#-knowing-your-elpa-directory><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>Eask creates an isolated environment, so it won&rsquo;t create any side effects after
137+
</span></span></code></pre></div><p>The output, and it shows there are 7 subcommands supported:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-text data-lang=text><span class=line><span class=cl>Delete various files produced during building
138+
</span></span><span class=line><span class=cl>
139+
</span></span><span class=line><span class=cl>Usage: eask clean &lt;type&gt; [options..]
140+
</span></span><span class=line><span class=cl>
141+
</span></span><span class=line><span class=cl>Commands:
142+
</span></span><span class=line><span class=cl> clean all Do all cleaning tasks [aliases: everything]
143+
</span></span><span class=line><span class=cl> clean autoloads Remove generated autoloads file
144+
</span></span><span class=line><span class=cl> clean dist [destination] Delete dist subdirectory [aliases: distribution]
145+
</span></span><span class=line><span class=cl> clean elc Remove byte compiled files generated by eask compile
146+
</span></span><span class=line><span class=cl> clean log-file Remove all generated log files
147+
</span></span><span class=line><span class=cl> clean pkg-file Remove generated pkg-file
148+
</span></span><span class=line><span class=cl> clean workspace Clean up .eask directory [aliases: .eask]
149+
</span></span><span class=line><span class=cl>
150+
</span></span><span class=line><span class=cl>Positionals:
151+
</span></span><span class=line><span class=cl> &lt;type&gt; type of the cleaning task
152+
</span></span><span class=line><span class=cl>
153+
</span></span><span class=line><span class=cl>...
154+
</span></span></code></pre></div><p>Here is a list of known nested subcommands:</p><ul><li>eask create</li><li>eask clean</li><li>eask generate</li><li>eask generate workflow</li><li>eask link</li><li>eask lint</li><li>eask run</li><li>eask source</li><li>eask test</li></ul><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-knowing-your-elpa-directory>📌 Knowing your <code>elpa</code> directory</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Basic-Usage/#-knowing-your-elpa-directory class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📌 Knowing your elpa directory" aria-label="Anchor to: 📌 Knowing your elpa directory" href=#-knowing-your-elpa-directory><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>Eask creates an isolated environment, so it won&rsquo;t create any side effects after
155155
playing, testing, and running your elisp packages. But it&rsquo;s important to know
156156
what elpa directory (you can think of this as your <code>.emacs.d</code>) the current Eask
157157
session is pointing to, so you can release the full potential of this tool!</p><p>Here is how Eask works behind the scene in different scenarios:</p><div class=table-wrap><table><thead><tr><th style=text-align:left>Name</th><th style=text-align:left>Description</th><th style=text-align:left>Options</th><th style=text-align:left>Path</th></tr></thead><tbody><tr><td style=text-align:left>local</td><td style=text-align:left>The default behavior, use Eask as package dev tool</td><td style=text-align:left>n/a</td><td style=text-align:left><code>./.eask</code></td></tr><tr><td style=text-align:left>config</td><td style=text-align:left>Use Eask as your package manager (It can be used as a test tool too)</td><td style=text-align:left><code>-c</code> or <code>--config</code></td><td style=text-align:left><code>~/.emacs.d</code></td></tr><tr><td style=text-align:left>global</td><td style=text-align:left>Use Eask as a general tool, it&rsquo;s unrelated to other scopes</td><td style=text-align:left><code>-g</code> or <code>--global</code></td><td style=text-align:left><code>~/.eask</code></td></tr></tbody></table></div><p>You might think of why these rules are created.</p><p>It&rsquo;s easy to understand <strong>config</strong> and <strong>local</strong> scopes since many other build

Getting-Started/Commands-and-options/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@
6565
</span></span><span class=line><span class=cl>
6666
</span></span><span class=line><span class=cl><span class=p>(</span><span class=nv>depends-on</span> <span class=s>&#34;emacs&#34;</span> <span class=s>&#34;26.1&#34;</span><span class=p>)</span>
6767
</span></span></code></pre></div><p><strong>[RECOMMENDED]</strong> If you already have an elisp project, you can convert the
68-
<code>.el</code> file to Eask-file:</p><pre tabindex=0><code>eask init --from source /path/to/source.el
69-
</code></pre><p>If you already have a <a class=gdoc-markdown__link href=https://github.com/cask/cask>Cask</a> project, you can convert Cask-file to Eask-file:</p><pre tabindex=0><code>eask init --from cask /path/to/Cask
70-
</code></pre><p>If you already have a <a class=gdoc-markdown__link href=https://emacs-eldev.github.io/eldev/>Eldev</a> project, you can convert Eldev-file to Eask-file:</p><pre tabindex=0><code>eask init --from eldev /path/to/Eldev
71-
</code></pre><p>If you already have a <a class=gdoc-markdown__link href=https://github.com/conao3/keg.el>Keg</a> project, you can convert Keg-file to Eask-file:</p><pre tabindex=0><code>eask init --from keg /path/to/Keg
72-
</code></pre><blockquote class="gdoc-hint note"><div class="gdoc-hint__title flex gap-8 align-center"><i class="fa note"></i>
68+
<code>.el</code> file to Eask-file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask init --from <span class=nb>source</span> /path/to/source.el
69+
</span></span></code></pre></div><p>If you already have a <a class=gdoc-markdown__link href=https://github.com/cask/cask>Cask</a> project, you can convert Cask-file to Eask-file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask init --from cask /path/to/Cask
70+
</span></span></code></pre></div><p>If you already have a <a class=gdoc-markdown__link href=https://emacs-eldev.github.io/eldev/>Eldev</a> project, you can convert Eldev-file to Eask-file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask init --from eldev /path/to/Eldev
71+
</span></span></code></pre></div><p>If you already have a <a class=gdoc-markdown__link href=https://github.com/conao3/keg.el>Keg</a> project, you can convert Keg-file to Eask-file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask init --from keg /path/to/Keg
72+
</span></span></code></pre></div><blockquote class="gdoc-hint note"><div class="gdoc-hint__title flex gap-8 align-center"><i class="fa note"></i>
7373
<span>Note</span></div><div class=gdoc-hint__text>💡 See section <a class=gdoc-markdown__link href=https://emacs-eask.github.io/examples>Examples</a> for more
7474
Eask-file examples!</div></blockquote><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-eask-info>🔍 eask info</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Commands-and-options/#-eask-info class="gdoc-page__anchor clip flex align-center" title="Anchor to: 🔍 eask info" aria-label="Anchor to: 🔍 eask info" href=#-eask-info><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>Show information about the project or configuration.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask <span class=o>[</span>GLOBAL-OPTIONS<span class=o>]</span> info
7575
</span></span></code></pre></div><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-eask-status>🔍 eask status</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Commands-and-options/#-eask-status class="gdoc-page__anchor clip flex align-center" title="Anchor to: 🔍 eask status" aria-label="Anchor to: 🔍 eask status" href=#-eask-status><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>Display the state of the workspace.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>eask <span class=o>[</span>GLOBAL-OPTIONS<span class=o>]</span> status

Getting-Started/Directory-Structure/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@
4848
<a href=https://github.com/emacs-eask/cli class=gdoc-nav__entry>View Source</a></span></label></li></ul></section></nav></aside><div class=gdoc-page><div class="gdoc-page__header flex flex-wrap
4949
justify-between" itemprop=breadcrumb><div><svg class="gdoc-icon gdoc_path hidden-mobile"><use xlink:href="#gdoc_path"/></svg><ol class=breadcrumb itemscope itemtype=https://schema.org/BreadcrumbList><li itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a itemscope itemtype=https://schema.org/WebPage itemprop=item itemid=/ href=/><span itemprop=name></span></a><meta itemprop=position content='1'></li><li>/</li><li itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a itemscope itemtype=https://schema.org/WebPage itemprop=item itemid=/Getting-Started/ href=/Getting-Started/><span itemprop=name>Getting Started</span></a><meta itemprop=position content='2'></li><li>/</li><li itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><span itemprop=name>🏗️ Directory Structure</span><meta itemprop=position content='3'></li></ol></div><div><span class=editpage><svg class="gdoc-icon gdoc_code"><use xlink:href="#gdoc_code"/></svg>
5050
<a href=https://github.com/emacs-eask/cli//edit/master/docs/content/Getting-Started/Directory-Structure/_index.en.md>Edit page</a></span></div></div><article class="gdoc-markdown gdoc-markdown__align--left" id=main-content tabindex=-1><h1>🏗️ Directory Structure</h1><div class="gdoc-toc gdoc-toc__level--3"><nav id=TableOfContents><ul><li><a href=#-directory-structure-explained>📂 Directory Structure Explained</a></li></ul></nav><hr></div><p>Running the <strong><code>eask create package</code></strong> generator from the command-line will create
51-
a directory with the following structure:</p><pre tabindex=0><code>.
52-
├── .gitignore
53-
├── Makefile
54-
├── Eask
55-
├── README.md
56-
└── {package-file}.el
57-
</code></pre><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-directory-structure-explained>📂 Directory Structure Explained</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Directory-Structure/#-directory-structure-explained class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📂 Directory Structure Explained" aria-label="Anchor to: 📂 Directory Structure Explained" href=#-directory-structure-explained><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>The following is a high-level overview of each of the files.</p><p><code>.gitignore</code></p><p>Gitignore file, to ignore files you don&rsquo;t like to include from your repository.
51+
a directory with the following structure:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-text data-lang=text><span class=line><span class=cl>.
52+
</span></span><span class=line><span class=cl>├── .gitignore
53+
</span></span><span class=line><span class=cl>├── Makefile
54+
</span></span><span class=line><span class=cl>├── Eask
55+
</span></span><span class=line><span class=cl>├── README.md
56+
</span></span><span class=line><span class=cl>└── {package-file}.el
57+
</span></span></code></pre></div><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-directory-structure-explained>📂 Directory Structure Explained</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Directory-Structure/#-directory-structure-explained class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📂 Directory Structure Explained" aria-label="Anchor to: 📂 Directory Structure Explained" href=#-directory-structure-explained><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>The following is a high-level overview of each of the files.</p><p><code>.gitignore</code></p><p>Gitignore file, to ignore files you don&rsquo;t like to include from your repository.
5858
By default, it already excludes <code>files</code> and <code>directories</code> that are generated by
5959
Eask.</p><p><code>Makefile</code></p><p>Makefile that has already included basic tests for your package. It now has
6060
the following tasks be default:</p><ul><li>Test build (packaging + installing)</li><li>Test byte-compile</li><li>Test checkdoc (style checker)</li><li>Test lint (package linter)</li></ul><p><code>README.md</code></p><p>The generated document file. This is used to display the main page

Getting-Started/Install-Eask/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@
8484
</span></span></code></pre></div><p>Alternatively, you can use our bucket to access the latest release.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>scoop bucket add emacs-eask/cli https://github.com/emacs-eask/packaging
8585
</span></span><span class=line><span class=cl>scoop install eask-cli
8686
</span></span></code></pre></div><div class="flex align-center gdoc-page__anchorwrap"><h3 id=-winget-windows>📦 Winget (Windows)</h3><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Install-Eask/#-winget-windows class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📦 Winget (Windows)" aria-label="Anchor to: 📦 Winget (Windows)" href=#-winget-windows><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p><a class=gdoc-markdown__link href=https://learn.microsoft.com/en-us/windows/package-manager/>Winget</a> is Microsoft’s official free and open-source package manager for Windows.
87-
To install the Eask CLI:</p><pre tabindex=0><code>winget install eask.cli
88-
</code></pre><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-build-from-source>💾 Build from source</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Install-Eask/#-build-from-source class="gdoc-page__anchor clip flex align-center" title="Anchor to: 💾 Build from source" aria-label="Anchor to: 💾 Build from source" href=#-build-from-source><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><div class="flex align-center gdoc-page__anchorwrap"><h3 id=-prerequisite-tools>🚩 Prerequisite Tools</h3><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Install-Eask/#-prerequisite-tools class="gdoc-page__anchor clip flex align-center" title="Anchor to: 🚩 Prerequisite Tools" aria-label="Anchor to: 🚩 Prerequisite Tools" href=#-prerequisite-tools><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><ul><li><a class=gdoc-markdown__link href=https://git-scm.com/>Git</a></li><li><a class=gdoc-markdown__link href=https://nodejs.org/en/>Node.js</a></li><li><a class=gdoc-markdown__link href=https://www.npmjs.com/>npm</a></li></ul><p>Alternatively, you can clone it directly from this repo</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl><span class=c1># clone the repo</span>
87+
To install the Eask CLI:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl>winget install eask.cli
88+
</span></span></code></pre></div><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-build-from-source>💾 Build from source</h2><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Install-Eask/#-build-from-source class="gdoc-page__anchor clip flex align-center" title="Anchor to: 💾 Build from source" aria-label="Anchor to: 💾 Build from source" href=#-build-from-source><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><div class="flex align-center gdoc-page__anchorwrap"><h3 id=-prerequisite-tools>🚩 Prerequisite Tools</h3><a data-clipboard-text=https://emacs-eask.github.io/Getting-Started/Install-Eask/#-prerequisite-tools class="gdoc-page__anchor clip flex align-center" title="Anchor to: 🚩 Prerequisite Tools" aria-label="Anchor to: 🚩 Prerequisite Tools" href=#-prerequisite-tools><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><ul><li><a class=gdoc-markdown__link href=https://git-scm.com/>Git</a></li><li><a class=gdoc-markdown__link href=https://nodejs.org/en/>Node.js</a></li><li><a class=gdoc-markdown__link href=https://www.npmjs.com/>npm</a></li></ul><p>Alternatively, you can clone it directly from this repo</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-sh data-lang=sh><span class=line><span class=cl><span class=c1># clone the repo</span>
8989
</span></span><span class=line><span class=cl>git clone https://github.com/emacs-eask/cli eask-cli
9090
</span></span><span class=line><span class=cl>
9191
</span></span><span class=line><span class=cl><span class=c1># change the working directory to eask-cli</span>

fonts/GeekdocIcons.woff

0 Bytes
Binary file not shown.

fonts/GeekdocIcons.woff2

20 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)