<script>!function(){functiont(t){document.documentElement.setAttribute("data-theme",t)}vare=function(){try{returnnewURLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{returnlocalStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{constc=newURLSearchParams(window.location.search).entries();for(var[t,e]ofc)if(t.startsWith("docusaurus-data-")){vara=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><divid="__docusaurus"><divrole="region"aria-label="Skip to main content"><aclass="skipToContent_fXgn"href="2.html#__docusaurus_skipToContent_fallback">Skip to main content</a></div><navaria-label="Main"class="navbar navbar--fixed-top"><divclass="navbar__inner"><divclass="navbar__items"><buttonaria-label="Toggle navigation bar"aria-expanded="false"class="navbar__toggle clean-btn"type="button"><svgwidth="30"height="30"viewBox="0 0 30 30"aria-hidden="true"><pathstroke="currentColor"stroke-linecap="round"stroke-miterlimit="10"stroke-width="2"d="M4 7h22M4 15h22M4 23h22"></path></svg></button><aclass="navbar__brand"href="../../index.html"><divclass="navbar__logo"><imgsrc="../../img/logo.svg"alt="Lisp Logo"class="themedComponent_mlkZ themedComponent--light_NVdE"><imgsrc="../../img/logo.svg"alt="Lisp Logo"class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><bclass="navbar__title text--truncate">Common Lisp Docs</b></a><aclass="navbar__item navbar__link"href="../../docs/tutorial.html">Tutorial</a><ahref="../../cl-language-reference/index.html"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link">Technical Reference</a><aclass="navbar__item navbar__link"href="../../docs/whylisp.html">Why Lisp?</a><aclass="navbar__item navbar__link"href="../../docs/howto.html">Guides</a></div><divclass="navbar__items navbar__items--right"><aclass="navbar__item navbar__link"href="../../docs/contribute.html">Contribute!</a><aclass="navbar__item navbar__link"href="../../docs/help.html">Getting Help</a><aclass="navbar__item navbar__link"href="../../docs/about.html">About</a><aaria-current="page"class="navbar__item navbar__link navbar__link--active"href="../../blog.html">Blog</a><ahref="https://github.com/lisp-docs"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link">GitHub<svgwidth="13.5"height="13.5"aria-hidden="true"viewBox="0 0 24 24"class="iconExternalLink_nPIU"><pathfill="currentColor"d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><divclass="toggle_vylO colorModeToggle_DEke"><buttonclass="clean-btn toggleButton_gllP toggleButtonDisabled_aARS"type="button"disabled=""title="Switch between dark and light mode (currently light mode)"aria-label="Switch between dark and light mode (currently light mode)"aria-live="polite"><svgviewBox="0 0 24 24"width="24"height="24"class="lightToggleIcon_pyhR"><pathfill="currentColor"d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svgviewBox=
<p>However, this is a work in progress.</p>
<p>These are the changes that are needed for it to reach a version 1.0:</p>
<ol>
<li><del>Fix all the markdown titles for the right side panel navigation bar. For some reason during the parsing, some of the titles got messed up in the navigation bar. The titles in the actual content are repeated. The second one must also be removed.</del><strong>Edit: 2023/11/26</strong></li>
<li>Need to link up all italics to the actual page in the reference.</li>
<li>Need to fix the tables in all the files. Idea: Could find each table in the original TeX files and parse those and replace the text in the current markdown since the original is hopefully structured.</li>
<li>Need to parse and find every bit of lisp code and wrap it in the proprer ``` backquote wrappers with the lisp syntax for pretty print. See #3, could try to see if the original TeX marked code blocks and use those with text replace.</li>
<li>Make sure everything else is good!</li>
<li><del>Change the <code>_category_.json</code> files to display position of chapters in sidebar correctly...</del><strong>Edit: 2023/11/27</strong></li>
<li><del>Change the <code>_category_.json</code> contents to use double quotes instead of single quotes...</del><strong>Edit: 2023/11/27</strong></li>
<li>Add search plugin</li>
<li>"beach": "The description of each operator should probably be on a separate page, because for the language reference, more material will be added there"</li>
</ol>
<p>However, with that said, the project is actually ready for contributions!</p>
<h2class="anchor anchorWithStickyNavbar_LWe7"id="how-the-project-is-structured">How The Project is Structured<ahref="2.html#how-the-project-is-structured"class="hash-link"aria-label="Direct link to How The Project is Structured"title="Direct link to How The Project is Structured"></a></h2>
<p>The idea here was to separate the files with the original dpANS3r text from the community additions. Therefore, to add examples or any content, just create a new file. Please name it relevant to the section you will add it to, and then just import it in that section like all the other files are imported.</p>
<p>So instead of writing the examples in the dpANS3r itself, it will be a new file <code>examples.md</code> where you can write anything you want. Then you would import it wherever relevant.</p>
<p>Please note that because react doesn't seem to allow using numbers in component names, I had to convert all numbers to letters. <code>A=0</code>, <code>B=1</code>, etc...</p></div><footerclass="row docusaurus-mt-lg"><divclass="col"><b>Tags:</b><ulclass="tags_jXut padding--none margin-left--sm"><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/status.html">status</a></li><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/todo.html">todo</a></li><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/beginning.html">beginning</a></li></ul></div></footer></article><articleclass="margin-bottom--xl"itemprop="blogPost"itemscope=""itemtype="https://schema.org/BlogPosting"><metaitemprop="description"content="The mission of Common Lisp Docs and this website in particular is to provide Common Lisp Documentation."><header><h2class="title_f1Hy"itemprop="headline"><aitemprop="url"href="../mission.html">Mission</a></h2><divclass="container_mt6G margin-vert--md"><timedatetime="2023-11-12T00:00:00.000Z"itemprop="datePublished">November 12, 2023</time> · <!---->One min read</div><divclass="margin-top--md margin-bottom--sm row"><divclass="col col--6 authorCol_Hf19"><divclass="avatar margin-bottom--sm"><divclass="avatar__intro"itemprop="author"itemscope=""itemtype="https://schema.org/Person"><divclass="avatar__name"><ahref="https://github.com/lisp-docs"target="_blank"rel="noopener noreferrer"itemprop="url"><spanitemprop="name">Daniel N</span></a></div><smallclass="avatar__subtitle"itemprop="description">Lisp Docs Core Team</small></div></div></div></div></header><divclass="markdown"itemprop="articleBody"><p>The mission of Common Lisp Docs and this website in particular is to provide Common Lisp Documentation.</p>
<p>The Docs in this Website are aimed to be a User Guide.</p>
<p>This website <ahref="../../cl-language-reference/index.html"target="_blank"rel="noopener noreferrer">Common Lisp Reference</a> is meant to be the reference.</p>
<p>We will hopefully soon come up with a tutorials website and more!</p>
<p>We aim to make this website as comprehensive as websites for other languages.</p>
<divclass="language-lisp codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-lisp codeBlock_bY9V thin-scrollbar"style="color:#393A34;background-color:#f6f8fa"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#393A34"><spanclass="token plain"></span><spanclass="token punctuation"style="color:#393A34">(</span><spanclass="token defun keyword"style="color:#00009f">defun</span><spanclass="token defun"></span><spanclass="token defun function"style="color:#d73a49">my-sqr</span><spanclass="token defun"></span><spanclass="token defun punctuation"style="color:#393A34">(</span><spanclass="token defun arguments argument variable"style="color:#36acaa">x</span><spanclass="token defun punctuation"style="color:#393A34">)</span><spanclass="token plain"></span><br></span><spanclass="token-line"style="color:#393A34"><spanclass="token plain"></span><spanclass="token punctuation"style="color:#393A34">(</span><spanclass="token car">*</span><spanclass="token plain"> x x</span><spanclass="token punctuation"style="color:#393A34">)</span><spanclass="token punctuation"style="color:#393A34">)</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgviewBox="0 0 24 24"class="copyButtonIcon_y97N"><pathfill="currentColor"d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgviewBox="0 0 24 24"class="copyButtonSuccessIcon_LjdS"><pathfill="currentColor"d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footerclass="row docusaurus-mt-lg"><divclass="col"><b>Tags:</b><ulclass="tags_jXut padding--none margin-left--sm"><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/mission.html">mission</a></li><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/beginning.html">beginning</a></li></ul></div></footer></article><articleclass="margin-bottom--xl"itemprop="blogPost"itemscope=""itemtype="https://schema.org/BlogPosting"><metaitemprop="description"content="The mission of Lisp Docs and this website in particular is to provide Common Lisp Documentation."><header><h2class="title_f1Hy"itemprop="headline"><aitemprop="url"href="../2023/11/12/mission.html">Mission</a></h2><divclass="container_mt6G margin-vert--md"><timedatetime="2023-11-12T00:00:00.000Z"itemprop="datePublished">November 12, 2023</time> · <!---->One min read</div><divclass="margin-top--md margin-bottom--sm row"><divclass="col col--6 authorCol_Hf19"><divclass="avatar margin-bottom--sm"><divclass="avatar__intro"itemprop="author"itemscope=""itemtype="https://schema.org/Person"><divclass="avatar__name"><ahref="https://github.com/lisp-docs"target="_blank"rel="noopener noreferrer"itemprop="url"><spanitemprop="name">Admin</span></a></div><smallclass="avatar__subtitle"itemprop="description">Common Lisp Docs Core Team</small></div></div></div></div></header><divclass="markdown"itemprop="articleBody"><p>The mission of Lisp Docs and this website in particular is to provide Common Lisp Documentation.</p>
<p>The <ahref="../../docs/tutorial.html">Docs in this Website</a> are aimed to be a User Guide.</p></div><footerclass="row docusaurus-mt-lg"><divclass="col"><b>Tags:</b><ulclass="tags_jXut padding--none margin-left--sm"><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/mission.html">mission</a></li><liclass="tag_QGVx"><aclass="tag_zVej tagRegular_sFm0"href="../tags/beginning.html">beginning</a></li></ul></div></footer></article><articleclass="margin-bottom--xl"itemprop="blogPost"itemscope=""itemtype="https://schema.org/BlogPosting"><metaitemprop="description"content="TODO"><header><h2class="title_f1Hy"itemprop="headline"><aitemprop="url"href="../TODO.html">TODO</a></h2><divclass="container_mt6G margin-vert--md"><timedatetime="2023-11-12T00:00:00.000Z"itemprop="datePublished">November 12, 2023</time> · <!---->One min read</div><divclass="margin-top--md margin-bottom--sm row"><divclass="col col--6 authorCol_Hf19"><divclass="avatar margin-bottom--sm"><divclass="avatar__intro"itemprop="author"itemscope=""itemtype="https://schema.org/Person"><divclass="avatar__name"><ahref="https://github.com/lisp-docs"target="_blank"rel="noopener noreferrer"itemprop="url"><spanitemprop="name">Daniel N</span></a></div><smallclass="avatar__subtitle"itemprop="description">Lisp Docs Core Team</small></div></div></div></div></header><divclass="markdown"itemprop="articleBody"><h2class="anchor anchorWithStickyNavbar_LWe7"id="todo">TODO<ahref="2.html#todo"class="hash-link"aria-label="Direct link to TODO"title="Direct link to TODO"></a></h2>
<ul>
<li>Find People to Help Us write the content of this website!</li>
<li>Add a Getting Started in Common Lisp Page</li>
<li>Add Links to the cookbook, HyperSpec, and Common Lisp, The Language 2<!---->
<ul>
<li>However, we eventually hope to completely replace the HyperSpec and CLTL2</li>
</ul>
</li>
<li>Add User Guide section and article stubs</li>
<li>Think about what to add</li>
<li>Add Beginner's User Guide</li>
<li>Add Normal User Guide which should be fully comprehensive</li>