Starting on guides

.docsanity.yaml

@@ -15,8 +15,8 @@ importedMembers: false
 # Information about the project.  By default these will be taken
 # from the assembly information of the first assembly.  Uncomment
 # and update the following lines to override
-# project:
-#     name: MyProject
+project:
+    name: RichTextKit
 #     version: 1.9
 
 # The assemblies for which documentation should be generated, 
@@ -24,7 +24,7 @@ importedMembers: false
 assemblies:
   - ./Build/Release/Topten.RichTextKit/netcoreapp2.1/Topten.RichTextKit.dll
 
-# Namespaces to assumed when formatting fully qualified type names
+# Namespaces to be assumed when formatting fully qualified type names
 namespaces:
   - System
   - System.Collections.Generic
@@ -33,50 +33,39 @@ namespaces:
 # The template and content files to be processed/copied
 content:
   - src: LosAngeles
-#  - del: /index.cshtml
-#  - src: ./readme.md
-#    dst: /index.md
-#  - src: /path/to/your/logo.png
-#    dst: /static/
-#  - src: /path/to/your/icon.png
-#    dst: /static/
-#  - src: /path/to/your/license.md
-#    dst: /
-
-# Optional links to be shown in the header
-# headers:
-#   - text: Your Site
-#     href: http://www.yoursite.com
-
-# Optional links to be shown in the footer
-# footers:
-#   - text: GitHub
-#     href: http://github.com/yourcompany/yourproject
-#   - text: License
-#     href: /license.html
-
-# Optional logo to be shown in header
-# logo:
-#     image: /static/logo.png
-#     href: /index.html
-
-# Smaller logo to be shown in header
-# icon:
-#     image: /static/icon.png
-#     href: /index.html
+  - dst: /index.md
+  - src: ./docsrc/
+  - src: ./Artwork/banner@2x.png
+    dst: /Artwork/
+  
 
 # Optional entries to go at the top of the table of contents
-#toc:
-#  - text: Getting Started
-#    href: .
-#    subItems:
-#      - text: Introduction
-#        href: .
+toc:
+  - text: Guides
+    href: .
+    subItems:
+      - text: Introduction
+        href: .
+      - text: Getting Started
+        href: gettingStarted
+      - text: Creating a TextBlock
+        href: createTextBlock
+      - text: Rendering Text
+        href: rendering
+      - text: Measuring Text
+        href: measuring
+      - text: Bidirectional Text
+        href: bidi
+      - text: Text Limits
+        href: limits
+      - text: Hit Testing
+        href: hittesting
+      - text: Styles
+        href: styles
+      - text: License
+        href: license
 
-# Optional arbitary data that will be available to templates 
-# via the `Settings.Data` property
-# data:
-#     anything: you like can go here
 
+# Optional data to pass to template
 data:
   projectUrlPrefix: "/richtextkit/"

doc/.common.page

@@ -1,10 +1,33 @@
 ---
-projectTitle: Topten.RichTextKit
+projectTitle: RichTextKit
 projectSubTitle: v0.1
 projectUrlPrefix: /richtextkit/
 prismLanguages:
   - csharp
 navTree:
+  - text: Guides
+    href: .
+    subItems:
+      - text: Introduction
+        href: .
+      - text: Getting Started
+        href: gettingStarted
+      - text: Creating a TextBlock
+        href: createTextBlock
+      - text: Rendering Text
+        href: rendering
+      - text: Measuring Text
+        href: measuring
+      - text: Bidirectional Text
+        href: bidi
+      - text: Text Limits
+        href: limits
+      - text: Hit Testing
+        href: hittesting
+      - text: Styles
+        href: styles
+      - text: License
+        href: license
   - text: Topten.RichTextKit
     href: ./ref/Topten.RichTextKit
     subItems:

doc/bidi.page

@@ -0,0 +1,8 @@
+---
+title: Bi-directional Text Support
+---
+
+# Bi-directional Text Support
+
+TODO!
+

doc/createTextBlock.page

@@ -0,0 +1,8 @@
+---
+title: Creating a TextBlock
+---
+
+# Creating a TextBlock
+
+TODO!
+

doc/gettingStarted.page

@@ -0,0 +1,7 @@
+---
+title: "Getting Started"
+isMarkdown: false
+---
+<h1 id="getting-started">Getting Started</h1>
+<p>TODO!</p>
+

doc/hittesting.page

@@ -0,0 +1,7 @@
+---
+title: Hit Testing
+---
+
+# Hit Testing
+
+TODO!

doc/index.page

@@ -1,6 +1,45 @@
----
-title: ""
-isMarkdown: false
----
-Welcome!
+<div class="banner" markdown=1>
+![Banner](./Artwork/banner@2x.png)
+</div>
 
+# RichTextKit
+
+RichTextKit is a rich-text layout, measurement and rendering library for SkiaSharp.
+
+## Features
+
+* Rich text layout
+* Supports most common font styles (bold, italic, underline, super/sub-script etc...)
+* Font shaping using HarfBuzzSharp
+* Font fallback for emoji and int'l character sets
+* Bi-directional and LTR/RTL Text Support (UAX #9)
+* Unicode word-break algorithm (UAX #14)
+* Max height and max line limits
+* Truncate with ellipsis support
+* Text measurement support
+* Hit testing and caret position information
+* Ability to paint selection range highlight
+* Easy to use
+* Minimal dependencies (just SkiaSharp and HarfBuzzSharp)
+
+## Under Development
+
+RichTextKit is still under development.  It works fine on Windows under net45 and 
+netcoreapp2.1 but hasn't been tested on other platforms.
+
+Also, text layout in general and Unicode and international text specifically are a 
+complicated topics - almost certainly there are issues I'm unaware of and I'm 
+hoping the community can help improve this project over time...
+
+That said, RichTextKit certainly does a better job than Skia on it's own.
+
+## Documentation
+
+<div class="primary-nav-shown">
+For documentation refer to the topics in the navigation panel to the left.
+</div>
+
+<div class="primary-nav-hidden">
+For documentation refer to the topics in the popup navigation menu accessible via the 
+menu button at the top left.
+</div>

doc/license.page

@@ -0,0 +1,17 @@
+---
+title: License
+---
+
+# License
+
+Copyright © 2019 Topten Software. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this 
+product except in compliance with the License. You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software distributed under 
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the specific language governing 
+permissions and limitations under the License.

doc/limits.page

@@ -0,0 +1,7 @@
+---
+title: Text Limits
+---
+
+# Text Limits
+
+TODO!

doc/measuring.page

@@ -0,0 +1,8 @@
+---
+title: Measuring Text
+---
+
+# Measuring Text
+
+TODO!
+

doc/rendering.page

@@ -0,0 +1,8 @@
+---
+title: Rendering Text
+---
+
+# Rendering Text
+
+TODO!
+

doc/styles.page

@@ -0,0 +1,8 @@
+---
+title: About Styles
+---
+
+# About Styles
+
+TODO!
+

docsrc/bidi.page

@@ -0,0 +1,8 @@
+---
+title: Bi-directional Text Support
+---
+
+# Bi-directional Text Support
+
+TODO!
+

docsrc/createTextBlock.page

@@ -0,0 +1,8 @@
+---
+title: Creating a TextBlock
+---
+
+# Creating a TextBlock
+
+TODO!
+

docsrc/gettingStarted.md

@@ -0,0 +1,7 @@
+---
+title: Getting Started
+---
+
+# Getting Started
+
+TODO!

docsrc/hittesting.page

@@ -0,0 +1,7 @@
+---
+title: Hit Testing
+---
+
+# Hit Testing
+
+TODO!

docsrc/index.page

@@ -0,0 +1,45 @@
+<div class="banner" markdown=1>
+![Banner](./Artwork/banner@2x.png)
+</div>
+
+# RichTextKit
+
+RichTextKit is a rich-text layout, measurement and rendering library for SkiaSharp.
+
+## Features
+
+* Rich text layout
+* Supports most common font styles (bold, italic, underline, super/sub-script etc...)
+* Font shaping using HarfBuzzSharp
+* Font fallback for emoji and int'l character sets
+* Bi-directional and LTR/RTL Text Support (UAX #9)
+* Unicode word-break algorithm (UAX #14)
+* Max height and max line limits
+* Truncate with ellipsis support
+* Text measurement support
+* Hit testing and caret position information
+* Ability to paint selection range highlight
+* Easy to use
+* Minimal dependencies (just SkiaSharp and HarfBuzzSharp)
+
+## Under Development
+
+RichTextKit is still under development.  It works fine on Windows under net45 and 
+netcoreapp2.1 but hasn't been tested on other platforms.
+
+Also, text layout in general and Unicode and international text specifically are a 
+complicated topics - almost certainly there are issues I'm unaware of and I'm 
+hoping the community can help improve this project over time...
+
+That said, RichTextKit certainly does a better job than Skia on it's own.
+
+## Documentation
+
+<div class="primary-nav-shown">
+For documentation refer to the topics in the navigation panel to the left.
+</div>
+
+<div class="primary-nav-hidden">
+For documentation refer to the topics in the popup navigation menu accessible via the 
+menu button at the top left.
+</div>

docsrc/license.page

@@ -0,0 +1,17 @@
+---
+title: License
+---
+
+# License
+
+Copyright © 2019 Topten Software. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this 
+product except in compliance with the License. You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software distributed under 
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the specific language governing 
+permissions and limitations under the License.

docsrc/limits.page

@@ -0,0 +1,7 @@
+---
+title: Text Limits
+---
+
+# Text Limits
+
+TODO!

docsrc/measuring.page

@@ -0,0 +1,8 @@
+---
+title: Measuring Text
+---
+
+# Measuring Text
+
+TODO!
+

docsrc/rendering.page

@@ -0,0 +1,8 @@
+---
+title: Rendering Text
+---
+
+# Rendering Text
+
+TODO!
+

docsrc/styles.page

@@ -0,0 +1,8 @@
+---
+title: About Styles
+---
+
+# About Styles
+
+TODO!
+

readme.md

@@ -16,6 +16,7 @@ RichTextKit is a rich-text layout, measurement and rendering library for SkiaSha
 * Truncate with ellipsis support
 * Text measurement support
 * Hit testing and caret position information
+* Ability to paint selection range highlight
 * Easy to use
 * Minimal dependencies (just SkiaSharp and HarfBuzzSharp)