Skip to content

Commit

Permalink
improve docs, add devenv menu icons
Browse files Browse the repository at this point in the history
  • Loading branch information
datkat21 committed Jan 30, 2024
1 parent b0f4612 commit 6d497a6
Show file tree
Hide file tree
Showing 9 changed files with 274 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -1774,6 +1774,7 @@ <h3 dir="auto">Using the Account service</h3>
Retrieve current user account data. Returns invalid data if a user is not logged in. Check using <code class="notranslate">.onlineAccount</code> (true if logged in, false if not) on the returned object.</li>
</ul>
<h2 dir="auto">Using libraries/components in your apps</h2>
<p dir="auto"><a href="libs-and-components.html"><strong>Read more on the updated components and libraries documentation here.</strong></a></p>
<p dir="auto">Libraries and components add extra functionality into your apps and make an easy, reusable way to do a certain thing.</p>
<p dir="auto">For example, the VirtualFS library can be used to read the file system:</p>
<div class="highlight highlight-source-js" dir="auto"><pre class="notranslate"><span class="pl-c">// in-app</span>
Expand All @@ -1783,7 +1784,6 @@ <h2 dir="auto">Using libraries/components in your apps</h2>
<span class="pl-c">// Read a file</span>
<span class="pl-k">const</span> <span class="pl-s1">fileContent</span> <span class="pl-c1">=</span> <span class="pl-k">await</span> <span class="pl-s1">vfs</span><span class="pl-kos">.</span><span class="pl-en">readFile</span><span class="pl-kos">(</span><span class="pl-s">"Root/myFile.txt"</span><span class="pl-kos">)</span><span class="pl-kos">;</span></pre></div>
<p dir="auto">More documentation on VirtualFS <a href="virtualFS.html">can be found here</a>.</p>
<p dir="auto"><a href="libs-and-components.html"><strong>Read more on the updated components and libraries documentation here.</strong></a></p>
<h2 dir="auto">Recent breaking changes to apps</h2>
<ul dir="auto">
<li>
Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,8 @@ The Account service has the following methods:

## Using libraries/components in your apps

[**Read more on the updated components and libraries documentation here.**](libs-and-components.md)

Libraries and components add extra functionality into your apps and make an easy, reusable way to do a certain thing.

For example, the VirtualFS library can be used to read the file system:
Expand All @@ -582,7 +584,6 @@ const fileContent = await vfs.readFile("Root/myFile.txt");

More documentation on VirtualFS [can be found here](virtualFS.md).

[**Read more on the updated components and libraries documentation here.**](libs-and-components.md)

## Recent breaking changes to apps

Expand Down
21 changes: 20 additions & 1 deletion docs/css-classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -1248,10 +1248,29 @@ <h6 dir="auto">Generated with <code class="notranslate">pluto-docs</code> runnin
</div>
<div class="content"><h1 dir="auto">CSS Classes</h1>
<p dir="auto"><a href="README.html">Back to README.md</a></p>
<ul dir="auto">
<li><a href="#css-classes">CSS Classes</a>
<ul dir="auto">
<li><a href="#layout">Layout</a></li>
<li><a href="#spacing">Spacing</a></li>
<li><a href="#layout-1">Layout</a>
<ul dir="auto">
<li><a href="#general">General</a></li>
<li><a href="#flexbox">Flexbox</a></li>
<li><a href="#flexbox-spacing">Flexbox Spacing</a></li>
</ul>
</li>
<li><a href="#display">Display</a></li>
<li><a href="#animation">Animation</a></li>
<li><a href="#color">Color</a></li>
</ul>
</li>
</ul>
<p dir="auto">There are many CSS classes that are available in Pluto. Until all of them are documented, here are a lot of the utility ones that are commonly used:</p>
<h2 dir="auto">Other</h2>
<h2 dir="auto">Layout</h2>
<ul dir="auto">
<li><code class="notranslate">with-sidebar</code> - Applied to a window's wrapper if you want to use a sidebar. Removes padding so that the sidebar is flush with the window edges.</li>
<li><code class="notranslate">iframe</code> - Applied to a window wrapper. Bypasses any sidebar position settings. Should be used if you are using in combination with a MenuBar instead of a Sidebar.</li>
</ul>
<h2 dir="auto">Spacing</h2>
<ul dir="auto">
Expand Down
14 changes: 13 additions & 1 deletion docs/css-classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@

[Back to README.md](README.md)

- [CSS Classes](#css-classes)
- [Layout](#layout)
- [Spacing](#spacing)
- [Layout](#layout-1)
- [General](#general)
- [Flexbox](#flexbox)
- [Flexbox Spacing](#flexbox-spacing)
- [Display](#display)
- [Animation](#animation)
- [Color](#color)

There are many CSS classes that are available in Pluto. Until all of them are documented, here are a lot of the utility ones that are commonly used:

## Other
## Layout

- `with-sidebar` - Applied to a window's wrapper if you want to use a sidebar. Removes padding so that the sidebar is flush with the window edges.
- `iframe` - Applied to a window wrapper. Bypasses any sidebar position settings. Should be used if you are using in combination with a MenuBar instead of a Sidebar.

## Spacing

Expand Down
Binary file added docs/images/menuBar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6d497a6

Please sign in to comment.