Skip to content

Commit b3340f4

Browse files
committed
update page cloud readme and support list
1 parent 55940d2 commit b3340f4

File tree

1 file changed

+50
-9
lines changed

1 file changed

+50
-9
lines changed

Snippets/Page Cloud 1/README.md

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,38 @@
1-
# Obsidian: Page Cloud : Version 1
2-
This snippet requires a copy of [Obsidian.md](obsidian.md/)
1+
# Obsidian: Page Cloud : Version 1 <!-- omit from toc -->
2+
- This snippet requires the program [Obsidian.md](obsidian.md/)
3+
- This snippet requires the [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)
4+
- This snippet has optional support for [Style Settings Plugin](https://github.com/mgmeyers/obsidian-style-settings)
5+
6+
---
7+
38
<br />
4-
This snippet requires the [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview).
9+
10+
## Table of Contents <!-- omit from toc -->
11+
12+
- [About](#about)
13+
- [Previews](#previews)
14+
- [Install](#install)
15+
- [Normal Version](#normal-version)
16+
- [Minified Version](#minified-version)
17+
- [Customization](#customization)
18+
- [Page Titles / Frontmatter Support](#page-titles--frontmatter-support)
19+
- [Filtering Folders and Pages](#filtering-folders-and-pages)
20+
- [Exclude Folders](#exclude-folders)
21+
- [Exclude Page](#exclude-page)
22+
- [Sort Order](#sort-order)
23+
- [Font Size](#font-size)
24+
- [Font Weight](#font-weight)
25+
- [Cloud Color Generation](#cloud-color-generation)
26+
- [Change Appearance / CSS](#change-appearance--css)
27+
28+
<br />
29+
30+
---
531

632
<br /><br />
733

834
## About
9-
The `Page Cloud` snippet will fetch a list of all the pages that exist within your vault and list them in a cloud format. Certain pages will display different font sizes and colors depending on how populated the page is with contents.
35+
The `Page Cloud - Version 1` snippet will fetch a list of all the pages that exist within your vault and list them in a cloud format. Certain pages will display different font sizes and colors depending on how populated the page is with contents.
1036

1137
<br />
1238

@@ -47,7 +73,7 @@ The following are preview images of what the snippet will do and appear like:
4773

4874
<br /><br />
4975

50-
## Usage
76+
## Install
5177

5278
- Install [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)
5379
- Pick one of the two versions below, copy the code, and paste it in your Obsidian note.
@@ -717,7 +743,7 @@ The section below explains how to customize this snippet.
717743
<br />
718744
<br />
719745
720-
### Page Titles
746+
### Page Titles / Frontmatter Support
721747
Each page within your vault will be displayed in a cloud structure. The name of each page displayed has several ways of being defined, and supports **frontmatter**.
722748
723749
<br />
@@ -811,7 +837,7 @@ const QueryStr = `-"Personal Stuff/My PIN Codes"`;
811837
<br />
812838
<br />
813839
814-
### Change Sorting
840+
### Sort Order
815841
This snippet allows for two ways of sorting pages:
816842
1. Alphabetically (Descending A-Z)
817843
2. Alphabetically (Ascending Z-A)
@@ -862,7 +888,7 @@ const weightWordCount = 0.3;
862888
<br />
863889
<br />
864890
865-
### Cloud Colors
891+
### Cloud Color Generation
866892
As of `v1.3.0`, this snippet auto generates the colors that will be used for each page listed in the cloud. The color generation code will keep the color tones in the **pastel** range, and will exclude darker colors since the background box color is dark.
867893
868894
<br />
@@ -879,4 +905,19 @@ let B = Math.floor( ( Math.random( ) * 100 ) + 100 );
879905
880906
For brighter colors, increase `100`. Don't exceed `255`.
881907
882-
For darker colors, decrease `100`. Don't go below `0`.
908+
For darker colors, decrease `100`. Don't go below `0`.
909+
910+
<br />
911+
<br />
912+
913+
### Change Appearance / CSS
914+
This snippet supports tweaking the look and feel of the cloud & tags using the **[Style Settings](https://github.com/mgmeyers/obsidian-style-settings)** plugin. If you want to change how the tags in this snippet look:
915+
- Open `Obsidian Settings`
916+
- Install the `Style Settings` plugin
917+
- Select `Style Settings` config panel under `Community Plugins`.
918+
- Click the tab `Page Cloud - Version 1`
919+
- Edit the settings for the Page Cloud tags
920+
921+
<br />
922+
923+
<p align="center"><img style="width: 100%;text-align: center;" src="https://raw.githubusercontent.com/Aetherinox/obsidian-dataview-snippets/main/Snippets/Page%20Cloud%201/images/install_4.gif"></p>

0 commit comments

Comments
 (0)