[ivette/doc] included gallery

ivette/Makefile

@@ -107,10 +107,13 @@ api:
 # --- Ivette Documentation
 # --------------------------------------------------------------------------
 
+.PHONY: icons
+
 VERSION=$(shell echo "console.log(require('./package.json').version)" | node -)
 
 DOC_ICONS_CSS= src/dome/doc/gallery.css
 DOC_ICONS_MAKE= src/dome/doc/iconsmd.js
+DOC_ICONS_GALLERY= src/dome/doc/guides/icons.md
 DOC_ICONS_DATA= src/dome/renderer/controls/gallery.json
 DOC_GUIDES= src/dome/doc/guides
 
@@ -118,30 +121,20 @@ NODEBIN= ./node_modules/.bin
 
 DOCDIRS= src/ivette src/frama-c src/dome/renderer src/dome/utils
 
-doc: $(NODEBIN)/typedoc
+icons: $(DOC_ICONS_GALLERY)
+
+$(DOC_ICONS_GALLERY): $(DOC_ICONS_MAKE) $(DOC_ICONS_DATA)
+	@rm -f $@
+	@node $(DOC_ICONS_MAKE) $(DOC_ICONS_DATA) > src/dome/doc/guides/icons.md
+	@chmod a-w $@
+
+doc: $(NODEBIN)/typedoc icons
 	@echo "\n[Ivette] documentation"
 	@rm -fr doc/html
 	@yarn run typedoc $(shell find $(DOCDIRS) -name "*.ts" -or -name "*.tsx")
-	@mkdir -p doc/html/guides
-	@echo "\n[Ivette] guides"
-	@node $(DOC_ICONS_MAKE) $(DOC_ICONS_DATA) > doc/html/guides/icons.md
-	@find $(DOC_GUIDES) -name "*.md" -exec cp -f {} doc/html/guides/ \;
-	@find doc/html/guides -name "*.md" -print -exec pandoc \
-		--standalone --toc --toc-depth=2 --to html \
-		--template doc/pandoc/template.html \
-		--metadata title="Ivette Documentation" \
-		--metadata version="v$(VERSION)" \
-		--metadata-file=doc/pandoc/index.json \
-		--lua-filter doc/pandoc/href.lua \
-		{} -o {}.html \; -delete
 	@echo "\n[Ivette] main page"
 	@echo "   file://$(PWD)/doc/html/index.html"
 
-# For searching the doc
-serve: $(NODEBIN)/serve
-	@echo "[Ivette] serve doc documentation"
-	@yarn run serve doc/html
-
 $(NODEBIN)/%:
 	@echo "[Node] install package $*"
 	yarn add -D $*

ivette/README.md

-## Ivette
-
-Main entry points:
-- [frama-c/server](modules/frama_c_server.html) Frama-C Server interaction (low level)
-- [frama-c/states](modules/frama_c_states.html) high-level request management
-
-## Command Line
-
-The following options are recognized by `./bin/frama-c-gui`:
-
-- `--cwd` working directory of Frama-C server
-- `--command` path to Frama-C binary
-- `--socket` ZeroMQ socket address of the server
-
-The default working directory is the current one.
-The default command is the local `bin/frama-c` of source installation.
-The default socket is `ipc:///.frama-c.<pid>.io`.
-
-## Dome Guides
-
-- [Dome Framework](guides/dome.md.html)
-- [Quick Start](guides/quickstart.md.html)
-- [Live Editing](guides/hotreload.md.html)
-- [Application Design](guides/application.md.html)
-- [Application Development](guides/development.md.html)
-- [Styling Components](guides/styling.md.html)
-- [Custom Hooks](guides/hooks.md.html)
-- [Icon Gallery](guides/icons.md.html)
-- [Glossary](guides/glossary.md.html)
+## Dome
+
+- [Dome Framework](src/dome/doc/guides/dome.md)
+- [Quick Start](src/dome/doc/guides/quickstart.md)
+- [Live Editing](src/dome/doc/guides/hotreload.md)
+- [Application Design](src/dome/doc/guides/guides/application.md)
+- [Application Development](src/dome/doc/guides/development.md)
+- [Styling Components](src/dome/doc/guides/styling.md)
+- [Custom Hooks](src/dome/doc/guides/hooks.md)
+- [Glossary](src/dome/doc/guides/glossary.md)

ivette/src/dome/doc/iconsmd.js

@@ -21,16 +21,15 @@ for ( var name in icons ) {
 index.sort();
 if (sections["Others"]) index.push("Others");
 
-console.log( '---' );
-console.log( 'subtitle: Icons Gallery' );
-console.log( '---' );
 console.log();
 
 // --- Gallery (per section) -----------------------------------------
 
 for ( var s = 0 ; s < index.length ; s++ ) {
   const section = index[s] ;
-  console.log( `## ${section} {#SECTION.${section}}` );
+  console.log( '<hr/>' );
+  console.log();
+  console.log( `## ${section}` );
   console.log();
   console.log( `  <div class="database">` );
 

ivette/src/dome/renderer/controls/icons.tsx

@@ -25,9 +25,11 @@
 // --------------------------------------------------------------------------
 
 /**
-   Consult the [Icon Gallery](../guides/icons.md.html) for default icons.
    You can [register](#.register) new icons or override existing ones
    and [iterate](#.forEach) over the icon base.
+
+   [[include:icons.md]]
+
    @packageDocumentation
    @module dome/controls/icons
  */

ivette/tsconfig.json

@@ -99,6 +99,8 @@
     "categoryOrder": [ "Hooks", "Components", "*", "Other" ],
     "listInvalidSymbolLinks":true,
     "hideGenerator":true,
-    "readme": "./README.md",
+    "includes": "src/dome/doc/guides",
+    "customCss": "src/dome/doc/gallery.css",
+    "readme": "none"
   }
 }