Skip to content

Commit

Permalink
feat: more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@LudeeD
LudeeD committed Dec 3, 2020
1 parent 854252a commit a8959e2
Show file tree
Hide file tree
Showing 11 changed files with 1,850 additions and 124 deletions.
75 changes: 75 additions & 0 deletions docs/api.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8" />
<title>App</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="static/style.css">
</head>
<body>
<div class="row">
<p><b>Last Update:</b> Thu, 03 Dec 2020 23:17:24 +0000</p>
<a href="index.html" style="float: right;"><p>Back to index 🏠</p></a>
</div>
<hr>
<h1>NOTA API</h1>
<pre><code>TODO: Still not stable
</code></pre>
<ul>
<li>
<p>nota init</p>
<ul>
<li>initializes the NOTA folders</li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
<li>
<p>nota list</p>
<ul>
<li>list available notas</li>
<li>Status: <em>TODO</em></li>
</ul>
</li>
<li>
<p>nota new <em>NAME</em></p>
<ul>
<li><em>NAME</em> is optional</li>
<li>if <em>NAME</em> is provided use it to create nota </li>
<li>if not create a new one under Daily/<CurrentDay></li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
<li>
<p>nota add <em>PATH</em></p>
<ul>
<li><em>PATH</em> is required</li>
<li>adds an existing markdown file to the nota folder </li>
<li>storing their metadata in the nota index</li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
<li>
<p>nota update <em>NAME</em></p>
<ul>
<li>updates the NOTA by adding their metadata to the index</li>
<li>Status: <em>TODO</em></li>
</ul>
</li>
<li>
<p>nota export <em>NAME</em></p>
<ul>
<li><em>NAME</em> is optional</li>
<li>exports the nota into the specific format, right now HTML</li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
</ul>

</body>
<footer>
<div class="row">
<p>Made with <a href="https://github.com/LudeeD/nota">NOTA</a></p>
<a href="#top" style="float: right;">To the top ⬆️</a>
</div>
</footer>
</html>
103 changes: 25 additions & 78 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,96 +1,43 @@
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8" />
<title>App</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<script charset="utf-8" src="js/app.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css">
<meta charset="utf-8" />
<title>App</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="static/style.css">
</head>
<body>
<form action="index.html">
<input style="float: right;" type="submit" value="Back to Index 🏡" />
</form>
<h1>NOTA Docs</h1>
<div class="row">
<p><b>Last Update:</b> Thu, 03 Dec 2020 23:18:24 +0000</p>
<a href="index.html" style="float: right;"><p>Back to index 🏠</p></a>
</div>
<hr>
<h1>NOTA Docs</h1>
<p>NOTA is a simple note taker tool that helps you organize your notes.</p>
<h1>Why Another tool ? Aren't there enough already ?</h1>
<h2>Why Another tool ? Aren't there enough already ?</h2>
<p>Yeah, there are and that is part of the problem NOTA aims to fix.
I wanted to write my notes like I like to write my code: with no predefined
I would like to write my notes like I like to write my code: with no predefined
editor, only tooling around the language.
I wanted to be this way for my notes too, I wanted to be able to edit and take
notes with any editor I wanted. No app lock in's no enforced programs or shaddy
web apps to use to do the things I wanted.</p>
No app lock in's, no enforced programs or shaddy web apps to use to do the things I wanted.</p>
<p>Simple text files, with a litle bit of tooling around for the extra producivity</p>
<p><strong>Very early state in the project, not ready in any way shape or form xD</strong></p>
<h1>Features</h1>
<h2>Features</h2>
<ul>
<li>Basic note management (create, update list, search)</li>
<li>Linking and Reverse Linking of notes</li>
<li>Export to other formats</li>
</ul>
<h1>Install</h1>
<ul>
<li>Download the binary</li>
<li>Add it to your path</li>
<li>Create a folder for your notes (optional)</li>
<li>Add a Environment Variable NOTA_FOLDER that points to the folder</li>
<li>You are good to go !</li>
</ul>
<h1>API</h1>
<ul>
<li>
<p>nota init</p>
<ul>
<li>initializes the NOTA folders</li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
<li>
<p>nota list</p>
<ul>
<li>list available notas</li>
<li>Status: <em>TODO</em></li>
</ul>
</li>
<li>
<p>nota new <em>NAME</em></p>
<ul>
<li><em>NAME</em> is optional</li>
<li>if <em>NAME</em> is provided use it to create nota </li>
<li>if not create a new one under Daily/<CurrentDay></li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
<li>
<p>nota add <em>PATH</em></p>
<ul>
<li><em>PATH</em> is required</li>
<li>adds an existing markdown file to the nota folder </li>
<li>storing their metadata in the nota index</li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
<li>
<p>nota update <em>NAME</em></p>
<ul>
<li>updates the NOTA by adding their metadata to the index</li>
<li>Status: <em>TODO</em></li>
</ul>
</li>
<li>
<p>nota export <em>NAME</em></p>
<ul>
<li><em>NAME</em> is optional</li>
<li>exports the nota into the specific format, right now HTML</li>
<li>Status: <em>Buggy</em></li>
</ul>
</li>
</ul>
<h2>Install</h2>
<pre><code>ToDo
</code></pre>
<h2>API</h2>
<p><a href="api.html">API Page</a></p>

<hr>
<a href="./index.html" style="float: left;">⬅️ Back to index</a>
<a href="#top" style="float: right;">To the top ⬆️</a>
<br/>
<div/>
</body>
<footer>
<div class="row">
<p>Made with <a href="https://github.com/LudeeD/nota">NOTA</a></p>
<a href="#top" style="float: right;">To the top ⬆️</a>
</div>
</footer>
</html>
Loading

0 comments on commit a8959e2

Please sign in to comment.