11Welcome to the CodeChat Editor
2- ==============================
2+ ================================================================================
33
44The CodeChat Editor is a GUI-based programmer's word processor /
55[ Jupyter] ( https://jupyter.org/ ) for software developers. This document describes
@@ -8,59 +8,58 @@ provides strategies for effectively employing the CodeChat Editor to improve the
88software development process.
99
1010Full manual
11- -----------
11+ --------------------------------------------------------------------------------
1212
13- Read the [ manual rendered using the CodeChat
14- Editor] ( https://codechat-editor.onrender.com/fw/fsb/opt/render/project/src/README.md ) ,
13+ Read the
14+ [ manual rendered using the CodeChat Editor] ( https://codechat-editor.onrender.com/fw/fsb/opt/render/project/src/README.md ) ,
1515since this documentation doesn't correctly render on GitHub.
1616
1717Installation
18- ------------
18+ --------------------------------------------------------------------------------
1919
20- Install the [ CodeChat Editor extension for Visual Studio
21- code] ( extensions/VSCode/README.md ) . For developers, see [ building from
22- source] ( docs/design.md ) .
20+ Install the
21+ [ CodeChat Editor extension for Visual Studio code] ( extensions/VSCode/README.md ) .
22+ For developers, see [ building from source] ( docs/design.md ) .
2323
2424Structure
25- ---------
25+ --------------------------------------------------------------------------------
2626
2727The CodeChat Editor divides source code into code blocks and documentation (doc)
28- blocks. These blocks are separated by newlines; the image below shows the [ style
29- guide] ( docs/style_guide.cpp ) on the left in the Visual Studio Code (VSCode) text
30- editor, while the right pane shows the same text from style guide in the
31- CodeChat Editor (using the VSCode extension). Specifically, this screenshot
32- shows:
33-
34- * <span style =" font-size : 20pt ;" >❶</span >: a doc block. Doc blocks must have
35- one space after the comment delimiter.
36- * <span style =" font-size : 20pt ;" >❷</span >: a code block. Comments on the same
37- line as code are not interpreted as doc blocks.
38- * <span style =" font-size : 20pt ;" >❸</span >: varying indents before a doc block.
39- * <span style =" font-size : 20pt ;" >❹</span >: [ Markdown] ( https://commonmark.org/ )
40- in a doc block; see a [ brief overview of
41- Markdown] ( https://commonmark.org/help/ ) .
42-
43- ![ Image showing code blocks and doc blocks in Visual Studio
44- Code] ( docs/code-blocks-doc-blocks.png )
28+ blocks. These blocks are separated by newlines; the image below shows the
29+ [ style guide] ( docs/style_guide.cpp ) on the left in the Visual Studio Code
30+ (VSCode) text editor, while the right pane shows the same text from style guide
31+ in the CodeChat Editor (using the VSCode extension). Specifically, this
32+ screenshot shows:
33+
34+ * <span style =" font-size : 20pt ;" >❶</span >: a doc block. Doc blocks must have one
35+ space after the comment delimiter.
36+ * <span style =" font-size : 20pt ;" >❷</span >: a code block. Comments on the same
37+ line as code are not interpreted as doc blocks.
38+ * <span style =" font-size : 20pt ;" >❸</span >: varying indents before a doc block.
39+ * <span style =" font-size : 20pt ;" >❹</span >: [ Markdown] ( https://commonmark.org/ )
40+ in a doc block; see a
41+ [ brief overview of Markdown] ( https://commonmark.org/help/ ) .
42+
43+ ![ Image showing code blocks and doc blocks in Visual Studio Code] ( docs/code-blocks-doc-blocks.png )
4544
4645See the [ style guide] ( docs/style_guide.cpp ) for more examples.
4746
4847Editing
49- -------
48+ --------------------------------------------------------------------------------
5049
5150Edits may be made either in the IDE hosting the CodeChat Editor, or within the
5251CodeChat Editor window itself. Edits made in one place are transferred to the
5352other after a short delay.
5453
5554Navigation
56- ----------
55+ --------------------------------------------------------------------------------
5756
5857Switching documents in the IDE likewise switches the document shown in the
5958CodeChat Editor. Likewise, following hyperlinks in the CodeChat Editor to a
6059local file loads that file in the IDE, as well as showing it in the Editor.
6160
6261References to other files
63- -------------------------
62+ --------------------------------------------------------------------------------
6463
6564The CodeChat Editor supports hyperlinks to any recognized file type; to refer to
6665another source file, simply insert a hyperlink to it. For example,
8382```
8483
8584Images
86- ------
85+ --------------------------------------------------------------------------------
8786
8887Likewise, the path to local images is relative to the current file's location
8988(see the preceding diagram for the location of ` monitor.png ` ). For example
@@ -98,18 +97,18 @@ mess -- the image data is embedded directly in the source file. Avoid this;
9897instead, place images in a separate file, then reference them as shown above.
9998
10099Projects
101- --------
100+ --------------------------------------------------------------------------------
102101
103102The CodeChat Editor can either display a single file, or a project. In a
104103project, the table of contents is displayed on the left, while a file within the
105104project is displayed on the right. To create a project, simply place a file
106105named ` toc.md ` at the root of your project [ \[ 2\] ] ( #notes ) ; its contents define
107- the table of contents. See the [ new project
108- template] ( https://github.com/bjones1/CodeChat_Editor/tree/main/new-project-template )
106+ the table of contents. See the
107+ [ new project template] ( https://github.com/bjones1/CodeChat_Editor/tree/main/new-project-template )
109108for a simple example.
110109
111110Mathematics
112- -----------
111+ --------------------------------------------------------------------------------
113112
114113The CodeChat Editor uses [ MathJax] ( https://www.mathjax.org/ ) to support typeset
115114mathematics. Place the delimiters ` $ ` or ` \\( ` and ` \\) ` immediately before and
@@ -141,20 +140,20 @@ following characters should be escaped: `*`, `_`, `\`, `[`, `]`, `<`.
141140| ` $a \; b$ ` | $a \; b$ | ` $a \\; b$ ` | $a \\ ; b$ |
142141
143142Diagrams
144- --------
143+ --------------------------------------------------------------------------------
145144
146145### Graphviz
147146
148147The CodeChat Editor contains rudimentary support for diagrams created by
149148[ Graphviz] ( https://graphviz.org/ ) . For example,
150149
151- | Source | Rendered |
152- | ----------------------------------------------------- | --------------------------------------------------- |
153- | ` <graphviz-graph>digraph { A -> B }</graphviz-graph> ` | <graphviz-graph >digraph { A -> B }</graphviz-graph > |
150+ | Source | Rendered |
151+ | ----------------------------------------------------- | ------------------------------------------------------ |
152+ | ` <graphviz-graph>digraph { A -> B }</graphviz-graph> ` | <graphviz-graph >digraph { A -& gt ; B }</graphviz-graph > |
154153
155- To edit these diagrams, use an [ HTML entity
156- encoder/decoder] ( https://mothereff.in/html-entities ) and a Graphviz editor such
157- as [ Edotor] ( https://edotor.net/ ) .
154+ To edit these diagrams, use an
155+ [ HTML entity encoder/decoder] ( https://mothereff.in/html-entities ) and a Graphviz
156+ editor such as [ Edotor] ( https://edotor.net/ ) .
158157
159158### Mermaid
160159
@@ -165,9 +164,9 @@ The CodeChat Editor contains rudimentary support for diagrams created by
165164| --------------------------------------------- | ---------------------------------------------- |
166165| ` <wc-mermaid>graph TD; A --> B;</wc-mermaid> ` | <wc-mermaid >graph TD; A --> ; B;</wc-mermaid > |
167166
168- To edit these diagrams, use an [ HTML entity
169- encoder/decoder] ( https://mothereff.in/html-entities ) and the [ Mermaid live
170- editor] ( https://mermaid.live/ ) .
167+ To edit these diagrams, use an
168+ [ HTML entity encoder/decoder] ( https://mothereff.in/html-entities ) and the
169+ [ Mermaid live editor] ( https://mermaid.live/ ) .
171170
172171### PlantUML
173172
@@ -178,43 +177,43 @@ diagram directly to an SVG; for example,
178177| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
179178| `  ` | ![ Sample PlantUML diagram] ( https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IW80 ) |
180179
181- To edit these diagrams, paste the URL into the [ PlantUML web
182- server] ( https://www.plantuml.com/plantuml/uml ) , click Decode URL, edit, then
183- copy and paste the SVG URL back to this file.
180+ To edit these diagrams, paste the URL into the
181+ [ PlantUML web server] ( https://www.plantuml.com/plantuml/uml ) , click Decode URL,
182+ edit, then copy and paste the SVG URL back to this file.
184183
185184<a id =" supported-languages " ></a >Supported languages
186- ---------------------------------------------------
187-
188- * C/C++
189- * C#
190- * CSS
191- * Go
192- * HTML
193- * Java/Kotlin
194- * JavaScript/ECMAScript and TypeScript
195- * JSON with comments ([ JSON5] ( https://json5.org/ ) )
196- * Markdown
197- * MATLAB
198- * Python
199- * Rust
200- * Shell scripts (` .sh ` )
201- * SQL
202- * Swift
203- * TOML
204- * VHDL
205- * Verilog/SystemVerilog
206- * Vlang
207- * YAML
185+ --------------------------------------------------------------------------------
186+
187+ * C/C++
188+ * C#
189+ * CSS
190+ * Go
191+ * HTML
192+ * Java/Kotlin
193+ * JavaScript/ECMAScript and TypeScript
194+ * JSON with comments ([ JSON5] ( https://json5.org/ ) )
195+ * Markdown
196+ * MATLAB
197+ * Python
198+ * Rust
199+ * Shell scripts (` .sh ` )
200+ * SQL
201+ * Swift
202+ * TOML
203+ * VHDL
204+ * Verilog/SystemVerilog
205+ * Vlang
206+ * YAML
208207
209208Issues and feature requests
210- ---------------------------
209+ --------------------------------------------------------------------------------
211210
212- Please report issues and provide suggestions for improvement using the [ Github
213- page for this project] ( https://github.com/bjones1/CodeChat_Editor ) .
211+ Please report issues and provide suggestions for improvement using the
212+ [ Github page for this project] ( https://github.com/bjones1/CodeChat_Editor ) .
214213Contributions to the code are welcome and encouraged!
215214
216215License
217- -------
216+ --------------------------------------------------------------------------------
218217
219218Copyright (C) 2025 Bryan A. Jones.
220219
@@ -235,11 +234,11 @@ License along with the CodeChat Editor. If not, see
235234[ https://www.gnu.org/licenses/ ] ( https://www.gnu.org/licenses/ ) .
236235
237236<a id =" notes " ></a >Notes
238- -----------------------
239-
240- 1 . The image used comes from [ Monitor icons created by prettycons -
241- Flaticon] ( https://www.flaticon.com/free-icons/monitor " monitor icons ") .
242- 2 . Note that the filename for the table of contents is lowercase; while the
243- acronym is TOC, requiring upper-case naming can cause confusion when moving
244- files between case-insensitive filesystems (Windows) and case-sensitive
245- filesystems (Linux/OS X).
237+ --------------------------------------------------------------------------------
238+
239+ 1 . The image used comes from
240+ [ Monitor icons created by prettycons - Flaticon] ( https://www.flaticon.com/free-icons/monitor " monitor icons ") .
241+ 2 . Note that the filename for the table of contents is lowercase; while the
242+ acronym is TOC, requiring upper-case naming can cause confusion when moving
243+ files between case-insensitive filesystems (Windows) and case-sensitive
244+ filesystems (Linux/OS X).
0 commit comments