chore: Readme changes

opa-oz · Jun 23, 2024 · 745e330 · 745e330
1 parent c99012f
commit 745e330
Show file tree

Hide file tree

Showing 31 changed files with 67 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -30,52 +30,57 @@ An implementation of the Language Protocol Server for [Pug.js](https://pugjs.org
 
 Project is under heavy development. Current functionality can be change in stable release.
 
+### Freestyle
+
+![preview](docs/preview.gif)
+
+
 ### Tags suggestions
 
 Auto suggest list of HTML5 tags.
 
-![tags-suggestions](docs/tags-suggestions.png)
+![tags-suggestions](docs/tags-and-keyword-suggestions.png)
 
 ### Attributes suggestions
 
 #### Auto suggest common attributes (such as `style`, `class`, `title`) for tags
 
-![common-attributes](docs/common-attributes.png)
+![common-attributes](docs/attributes-suggestion.png)
 
 #### Auto suggest events (such as `onclick`, `onenter`) for tags
 
-![events-attributes](docs/events-attributes.png)
+![events-attributes](docs/events-suggestion.png)
 
 #### Auto suggest tag-specific attributes (such as `href` for `a`)
 
-![special-attributes](docs/special-attributes.png)
+![special-attributes](docs/specific-attributes-siggestions.png)
 
 #### `&attributes` snippet
 
 _Yes, it's [a real feature](https://pugjs.org/language/attributes.html#attributes) of Pug_
 
-![attributes-shortcut](docs/attributes-shortcut.png)
+![attributes-shortcut](docs/and-attributes-suggestion.png)
 
 ### Mixins suggestions
 
 Look through included files and suggest defined mixins!
 
-![mixins](docs/mixins-suggestions.png)
+![mixins](docs/mixins-suggestion.png)
 
 
 ### `Doctype` suggestions
 
 PugJS has [a pre-defined list](https://pugjs.org/language/doctype.html) of possible doctypes. 
 
-![doctypes](docs/doctypes.png)
+![doctypes](docs/doctype-suggestion.png)
 
 ### Keywords suggestions
 
 #### `case .. when .. default`
 
 Pug-LSP simply follows [Pug's implementation](https://pugjs.org/language/case.html)
 
-![case-suggestions](/docs/case-suggestions.png)
+![case-suggestions](/docs/default-snippet.png)
 
 _Note_ [Case Fall Through](https://pugjs.org/language/case.html#case-fall-through)
 
@@ -90,13 +95,28 @@ If you would like to not output anything in a specific case, add an explicit unb
 
 #### `if .. else`
 
-![if-suggestion](docs/if-suggestions.png)
+![if-suggestion](docs/if-suggest.png)
 
 
 ### Hover reference
 
 See full desciption on hover!
-![hover-reference](docs/hover-suggestions.png)
+![hover-reference](docs/on-hover.png)
+
+### Diagnostics
+
+#### Include 
+
+Check if filepath is valid
+![includes-diag](docs/includes-diagnostic.png)
+
+#### Mixins
+
+1. Check if mixin exists (_or included_)
+![mixins-diag](docs/mixins-diagnostic.png)
+
+2. Check if desired arguments passed
+![mixin-arguments](docs/mixin-arguments-check.png)
 
 
 ## Thanks

diff --git a/docs/and-attributes-suggestion.png b/docs/and-attributes-suggestion.png
diff --git a/docs/attributes-shortcut.png b/docs/attributes-shortcut.png
diff --git a/docs/attributes-suggestion.png b/docs/attributes-suggestion.png
diff --git a/docs/break-snippet.png b/docs/break-snippet.png
diff --git a/docs/case-suggestions.png b/docs/case-suggestions.png
diff --git a/docs/common-attributes.png b/docs/common-attributes.png
diff --git a/docs/default-snippet.png b/docs/default-snippet.png
diff --git a/docs/doctype-suggestion.png b/docs/doctype-suggestion.png
diff --git a/docs/doctypes.png b/docs/doctypes.png
diff --git a/docs/events-attributes.png b/docs/events-attributes.png
diff --git a/docs/events-suggestion.png b/docs/events-suggestion.png
diff --git a/docs/hover-suggestions.png b/docs/hover-suggestions.png
diff --git a/docs/if-suggest.png b/docs/if-suggest.png
diff --git a/docs/if-suggestions.png b/docs/if-suggestions.png
diff --git a/docs/includes-diagnostic.png b/docs/includes-diagnostic.png
diff --git a/docs/mixin-arguments-check.png b/docs/mixin-arguments-check.png
diff --git a/docs/mixins-diagnostic.png b/docs/mixins-diagnostic.png
diff --git a/docs/mixins-suggestion.png b/docs/mixins-suggestion.png
diff --git a/docs/mixins-suggestions.png b/docs/mixins-suggestions.png
diff --git a/docs/on-hover.png b/docs/on-hover.png
diff --git a/docs/preview.gif b/docs/preview.gif
diff --git a/docs/special-attributes.png b/docs/special-attributes.png
diff --git a/docs/specific-attributes-siggestions.png b/docs/specific-attributes-siggestions.png
diff --git a/docs/subject/includes/footer.pug b/docs/subject/includes/footer.pug
@@ -0,0 +1,2 @@
+footer
+    span Copyright &copy; 2024
diff --git a/docs/subject/includes/head.pug b/docs/subject/includes/head.pug
@@ -0,0 +1,2 @@
+head
+    title Test subject
diff --git a/docs/subject/index.pug b/docs/subject/index.pug
@@ -0,0 +1,13 @@
+include mixins/header
+include mixins/paragraph
+
+doctype html
+html(lang="en")
+    include includes/head
+
+    body(onload="")
+       +h2("My subheader")
+       +paragraph
+            span My paragraph
+
+    include includes/footer
diff --git a/docs/subject/mixins/header.pug b/docs/subject/mixins/header.pug
@@ -0,0 +1,17 @@
+mixin h1(title)
+    h1= title
+
+mixin h2(title)
+    h2= title
+
+mixin h3(title)
+    h3= title
+
+mixin h4(title)
+    h4= title
+
+mixin h5(title)
+    h5= title
+
+mixin h6(title)
+    h6= title
diff --git a/docs/subject/mixins/paragraph.pug b/docs/subject/mixins/paragraph.pug
@@ -0,0 +1,3 @@
+mixin paragraph
+    p.paragraph
+        block
diff --git a/docs/tags-and-keyword-suggestions.png b/docs/tags-and-keyword-suggestions.png
diff --git a/docs/tags-suggestions.png b/docs/tags-suggestions.png