|
50 | 50 | <label><span class=flex><svg class="gdoc-icon gdoc_github"><use xlink:href="#gdoc_github"/></svg> |
51 | 51 | <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 |
52 | 52 | 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=/Contributing/ href=/Contributing/><span itemprop=name>Contributing</span></a><meta itemprop=position content='2'></li><li>/</li><li itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><span itemprop=name>✒️ Documentation</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> |
53 | | -<a href=https://github.com/emacs-eask/cli//edit/master/docs/content/Contributing/Documentation/_index.en.md>Edit page</a></span></div></div><article class="gdoc-markdown gdoc-markdown__align--left" id=main-content tabindex=-1><h1>✒️ Documentation</h1><div class="gdoc-toc gdoc-toc__level--3"><nav id=TableOfContents><ul><li><ul><li><a href=#-prerequisites>🚩 Prerequisites</a></li><li><a href=#-setup>📐 Setup</a></li></ul></li></ul></nav><hr></div><p>Eask includes a comprehensive user guide. Please try to extend it accordingly while |
| 53 | +<a href=https://github.com/emacs-eask/cli//edit/master/docs/content/Contributing/Documentation/_index.en.md>Edit page</a></span></div></div><article class="gdoc-markdown gdoc-markdown__align--left" id=main-content tabindex=-1><h1>✒️ Documentation</h1><div class="gdoc-toc gdoc-toc__level--3"><nav id=TableOfContents><ul><li><a href=#-prerequisites>🚩 Prerequisites</a></li><li><a href=#-setup>📐 Setup</a></li></ul></nav><hr></div><p>Eask includes a comprehensive user guide. Please try to extend it accordingly while |
54 | 54 | you implement new features.</p><p>The documentation is written in <a class=gdoc-markdown__link href=https://gohugo.io/>Markdown</a>, using <a class=gdoc-markdown__link href>Hugo</a> and GitHub Pages. |
55 | 55 | The former is the static site generator, and the latter is the static web pages hosting service |
56 | 56 | from GitHub.</p><blockquote class="gdoc-hint note"><div class="gdoc-hint__title flex gap-8 align-center"><i class="fa note"></i> |
57 | | -<span>Note</span></div><div class=gdoc-hint__text>💡 You can find all our documentation under the <strong>docs/content/</strong> folder.</div></blockquote><div class="flex align-center gdoc-page__anchorwrap"><h3 id=-prerequisites>🚩 Prerequisites</h3><a data-clipboard-text=https://emacs-eask.github.io/Contributing/Documentation/#-prerequisites class="gdoc-page__anchor clip flex align-center" title="Anchor to: 🚩 Prerequisites" aria-label="Anchor to: 🚩 Prerequisites" href=#-prerequisites><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>To make changes to documentation, you should have:</p><ul><li><a class=gdoc-markdown__link href=https://gohugo.io/getting-started/quick-start/#step-1-install-hugo>hugo</a> |
58 | | -executable; the static site generator.</li></ul><div class="flex align-center gdoc-page__anchorwrap"><h3 id=-setup>📐 Setup</h3><a data-clipboard-text=https://emacs-eask.github.io/Contributing/Documentation/#-setup class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📐 Setup" aria-label="Anchor to: 📐 Setup" href=#-setup><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>To set up the website locally, you need to first install the theme:</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 repository with submodules...</span> |
| 57 | +<span>Note</span></div><div class=gdoc-hint__text>💡 You can find all our documentation under the <strong>docs/content/</strong> folder.</div></blockquote><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-prerequisites>🚩 Prerequisites</h2><a data-clipboard-text=https://emacs-eask.github.io/Contributing/Documentation/#-prerequisites class="gdoc-page__anchor clip flex align-center" title="Anchor to: 🚩 Prerequisites" aria-label="Anchor to: 🚩 Prerequisites" href=#-prerequisites><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>To make changes to documentation, you should have:</p><ul><li><a class=gdoc-markdown__link href=https://gohugo.io/getting-started/quick-start/#step-1-install-hugo>hugo</a> |
| 58 | +executable; the static site generator.</li></ul><div class="flex align-center gdoc-page__anchorwrap"><h2 id=-setup>📐 Setup</h2><a data-clipboard-text=https://emacs-eask.github.io/Contributing/Documentation/#-setup class="gdoc-page__anchor clip flex align-center" title="Anchor to: 📐 Setup" aria-label="Anchor to: 📐 Setup" href=#-setup><svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"/></svg></a></div><p>To set up the website locally, you need to first install the theme:</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 repository with submodules...</span> |
59 | 59 | </span></span><span class=line><span class=cl>git clone https://github.com/emacs-eask/cli --recurse-submodules |
60 | 60 | </span></span><span class=line><span class=cl> |
61 | 61 | </span></span><span class=line><span class=cl><span class=c1># Navgiate to `docs/theme/geekdoc` folder</span> |
|
0 commit comments