-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* migrating documentation to Writerside * migrating documentation to Writerside
- Loading branch information
Showing
71 changed files
with
294 additions
and
134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,74 @@ | ||
name: Build & Deploy Docs | ||
on: | ||
push: | ||
branches: | ||
- master | ||
paths: | ||
- 'docs/**' | ||
- 'mkdocs.yml' | ||
# To trigger the workflow once you push to the `main` branch | ||
# Replace `main` with your branch’s name | ||
branches: ["main"] | ||
# Specify to run a workflow manually from the Actions tab on GitHub | ||
workflow_dispatch: | ||
|
||
permissions: | ||
id-token: write | ||
pages: write | ||
|
||
env: | ||
# Name of module and id separated by a slash | ||
INSTANCE: Writerside/fd | ||
# Replace XX with the ID of the instance in capital letters | ||
ARTIFACT: webHelpFD2-all.zip | ||
# Docker image version | ||
DOCKER_VERSION: 241.15989 | ||
|
||
jobs: | ||
build: | ||
name: Deploy docs | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- 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 artifact | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: docs | ||
path: | | ||
artifacts/${{ env.ARTIFACT }} | ||
retention-days: 7 | ||
|
||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
# Requires build job results | ||
needs: build | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout master | ||
uses: actions/checkout@v1 | ||
- name: Download artifact | ||
uses: actions/download-artifact@v4 | ||
with: | ||
name: docs | ||
|
||
- name: Unzip artifact | ||
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir | ||
|
||
- name: Setup Pages | ||
uses: actions/configure-pages@v4.0.0 | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3.0.1 | ||
with: | ||
path: dir | ||
|
||
- name: Deploy docs | ||
uses: mhausenblas/mkdocs-deploy-gh-pages@master | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4.0.4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
|
||
<variables></variables> | ||
<build-profile instance="fd"> | ||
<variables> | ||
<noindex-content>true</noindex-content> | ||
</variables> | ||
</build-profile> | ||
|
||
</buildprofiles> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE instance-profile | ||
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd"> | ||
|
||
<instance-profile id="fd" | ||
name="Fred Docs" start-page="index.md"> | ||
<toc-element topic="index.md"/> | ||
<toc-element topic="fred_for_existing_modxers.md"/> | ||
<toc-element topic="getting_started.md"/> | ||
<toc-element topic="templates.md"/> | ||
<toc-element topic="elements.md"/> | ||
<toc-element topic="blueprints.md"/> | ||
<toc-element toc-title="Creating a Theme"> | ||
<toc-element topic="themer_index.md"/> | ||
<toc-element topic="themes.md"/> | ||
<toc-element topic="convert-to-fred.md"/> | ||
<toc-element toc-title="Fred Templates"> | ||
<toc-element topic="templates_index.md"/> | ||
</toc-element> | ||
<toc-element toc-title="Fred Elements"> | ||
<toc-element topic="elements_index.md"/> | ||
<toc-element topic="markup.md"/> | ||
<toc-element topic="attributes.md"/> | ||
<toc-element topic="js_events.md"/> | ||
</toc-element> | ||
<toc-element toc-title="Fred Options"> | ||
<toc-element topic="options_index.md"/> | ||
<toc-element topic="settings.md"/> | ||
<toc-element topic="import.md"/> | ||
<toc-element topic="override.md"/> | ||
</toc-element> | ||
<toc-element toc-title="Fred CMP"> | ||
<toc-element topic="cmp_elements.md"/> | ||
<toc-element topic="element_categories.md"/> | ||
<toc-element topic="option_sets.md"/> | ||
<toc-element topic="rte_configs.md"/> | ||
<toc-element topic="rebuild.md"/> | ||
<toc-element topic="cmp_blueprints.md"/> | ||
<toc-element topic="blueprint_categories.md"/> | ||
<toc-element topic="cmp_themes.md"/> | ||
<toc-element topic="themed_templates.md"/> | ||
<toc-element topic="media_sources.md"/> | ||
<toc-element topic="theme_settings_and_resolvers.md"/> | ||
</toc-element> | ||
<toc-element topic="rte_configs_index.md"/> | ||
<toc-element topic="system_settings_index.md"/> | ||
<toc-element topic="media_sources_index.md"/> | ||
</toc-element> | ||
<toc-element toc-title="Site Administration"> | ||
<toc-element toc-title="ACLs"> | ||
<toc-element topic="howto.md"/> | ||
<toc-element topic="permissions.md"/> | ||
<toc-element topic="policies.md"/> | ||
</toc-element> | ||
</toc-element> | ||
<toc-element toc-title="Using with Gitify"> | ||
<toc-element topic="collab_index.md"/> | ||
<toc-element topic="gitify.md"/> | ||
<toc-element topic="initial_extract.md"/> | ||
<toc-element topic="gitify_in_action.md"/> | ||
<toc-element topic="pr_workflow.md"/> | ||
</toc-element> | ||
<toc-element toc-title="Plugin Development"> | ||
<toc-element topic="developer_index.md"/> | ||
<toc-element topic="sidebar_plugins.md"/> | ||
<toc-element topic="toolbar_plugins.md"/> | ||
<toc-element topic="modx_events.md"/> | ||
</toc-element> | ||
|
||
<toc-element topic="credits.md"/> | ||
</instance-profile> |
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
Oops, something went wrong.