1

.github/workflows/deploy.yml

@@ -0,0 +1,102 @@
+name: Build documentation
+
+on:
+ # If specified, the workflow will be triggered automatically once you push to the `main` branch.
+ # Replace `main` with your branch’s name
+ push:
+ branches: ["main"]
+ # Specify to run a workflow manually from the Actions tab on GitHub
+ workflow_dispatch:
+
+# Gives the workflow permissions to clone the repo and create a page deployment
+permissions:
+ id-token: write
+ pages: write
+
+env:
+ # Name of help module and instance id separated by a slash
+ INSTANCE: Writerside/hi
+ # Replace HI with the ID of the instance in capital letters
+ ARTIFACT: webHelpHI2-all.zip
+ # Writerside docker image version
+ DOCKER_VERSION: 233.14389
+ # Add the variable below to upload Algolia indexes
+ # Replace HI with the ID of the instance in capital letters
+ ALGOLIA_ARTIFACT: algolia-indexes-HI.zip
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Build Writerside docs using Docker
+ uses: JetBrains/writerside-github-action@v4
+ with:
+ instance: ${{ env.INSTANCE }}
+ artifact: ${{ env.ARTIFACT }}
+ docker-version: ${{ env.DOCKER_VERSION }}
+
+ - name: Upload documentation
+ uses: actions/upload-artifact@v3
+ with:
+ name: docs
+ path: |
+ artifacts/${{ env.ARTIFACT }}
+ artifacts/report.json
+ retention-days: 7
+
+ # Add the step below to upload Algolia indexes
+ - name: Upload algolia-indexes
+ uses: actions/upload-artifact@v3
+ with:
+ name: algolia-indexes
+ path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+ retention-days: 7
+
+ # Add the job below and artifacts/report.json on Upload documentation step above
+ # if you want to fail the build when documentation contains errors
+ test:
+ # Requires build job results
+ needs: build
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download artifacts
+ uses: actions/download-artifact@v1
+ with:
+ name: docs
+ path: artifacts
+
+ - name: Test documentation
+ uses: JetBrains/writerside-checker-action@v1
+ with:
+ instance: ${{ env.INSTANCE }}
+
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ # Requires the test job results
+ needs: test
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download artifact
+ uses: actions/download-artifact@v3
+ with:
+ name: docs
+
+ - name: Unzip artifact
+ run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+ - name: Setup Pages
+ uses: actions/configure-pages@v2
+
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v1
+ with:
+ path: dir
+
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v1

Writerside/c.list

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+ SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+ <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>

Writerside/hi.tree

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+ SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="hi"
+ name="h i"
+ start-page="starter-topic.md">
+
+ <toc-element topic="starter-topic.md"/>
+</instance-profile>

Writerside/topics/starter-topic.md

@@ -0,0 +1,79 @@
+# About h i
+
+<!--Writerside adds this topic when you create a new documentation project.
+You can use it as a sandbox to play with Writerside features, and remove it from the TOC when you don't need it anymore.-->
+
+## Add new topics
+You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started:
+
+![Create new topic options](new_topic_options.png){ width=290 }{border-effect=line}
+
+## Write content
+%product% supports two types of markup: Markdown and XML.
+When you create a new help article, you can choose between two topic types, but this doesn't mean you have to stick to a single format.
+You can author content in Markdown and extend it with semantic attributes or inject entire XML elements.
+
+## Inject XML
+For example, this is how you inject a procedure:
+
+<procedure title="Inject a procedure" id="inject-a-procedure">
+ <step>
+  <p>Start typing and select a procedure type from the completion suggestions:</p>
+  <img src="completion_procedure.png" alt="completion suggestions for procedure" border-effect="line"/>
+ </step>
+ <step>
+  <p>Press <shortcut>Tab</shortcut> or <shortcut>Enter</shortcut> to insert the markup.</p>
+ </step>
+</procedure>
+
+## Add interactive elements
+
+### Tabs
+To add switchable content, you can make use of tabs (inject them by starting to type `tab` on a new line):
+
+<tabs>
+ <tab title="Markdown">
+  <code-block lang="plain text">![Alt Text](new_topic_options.png){ width=450 }</code-block>
+ </tab>
+ <tab title="Semantic markup">
+  <code-block lang="xml">
+  <![CDATA[<img src="new_topic_options.png" alt="Alt text" width="450px"/>]]></code-block>
+ </tab>
+</tabs>
+
+### Collapsible blocks
+Apart from injecting entire XML elements, you can use attributes to configure the behavior of certain elements.
+For example, you can collapse a chapter that contains non-essential information:
+
+#### Supplementary info {collapsible="true"}
+Content under a collapsible header will be collapsed by default,
+but you can modify the behavior by adding the following attribute:
+`default-state="expanded"`
+
+### Convert selection to XML
+If you need to extend an element with more functions, you can convert selected content from Markdown to semantic markup.
+For example, if you want to merge cells in a table, it's much easier to convert it to XML than do this in Markdown.
+Position the caret anywhere in the table and press <shortcut>Alt+Enter</shortcut>:
+
+<img src="convert_table_to_xml.png" alt="Convert table to XML" width="706" border-effect="line"/>
+
+## Feedback and support
+Please report any issues, usability improvements, or feature requests to our
+<a href="https://youtrack.jetbrains.com/newIssue?project=WRS">YouTrack project</a>
+(you will need to register).
+
+You are welcome to join our
+<a href="https://jb.gg/WRS_Slack">public Slack workspace</a>.
+Before you do, please read our [Code of conduct](https://plugins.jetbrains.com/plugin/20158-writerside/docs/writerside-code-of-conduct.html).
+We assume that you’ve read and acknowledged it before joining.
+
+You can also always email us at [writerside@jetbrains.com](mailto:writerside@jetbrains.com).
+
+<seealso>
+ <category ref="wrs">
+  <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/markup-reference.html">Markup reference</a>
+  <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/manage-table-of-contents.html">Reorder topics in the TOC</a>
+  <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/local-build.html">Build and publish</a>
+  <a href="https://plugins.jetbrains.com/plugin/20158-writerside/docs/configure-search.html">Configure Search</a>
+ </category>
+</seealso>

Writerside/v.list

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
+<vars>
+ <var name="product" value="Writerside"/>
+</vars>

Writerside/writerside.cfg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
+
+<ihp version="2.0">
+ <topics dir="topics" web-path="topics"/>
+ <images dir="images" web-path="images"/>
+ <instance src="hi.tree" web-path="/hi/" version="1.0"/>
+</ihp>