diff --git a/Writerside/c.list b/Writerside/c.list new file mode 100644 index 0000000..c4c77a2 --- /dev/null +++ b/Writerside/c.list @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml new file mode 100644 index 0000000..9d953bb --- /dev/null +++ b/Writerside/cfg/buildprofiles.xml @@ -0,0 +1,13 @@ + + + + + + + + false + + + + diff --git a/Writerside/dcs.tree b/Writerside/dcs.tree new file mode 100644 index 0000000..1f27525 --- /dev/null +++ b/Writerside/dcs.tree @@ -0,0 +1,10 @@ + + + + + + + \ No newline at end of file diff --git a/Writerside/images/completion_procedure.png b/Writerside/images/completion_procedure.png new file mode 100644 index 0000000..3535a3f Binary files /dev/null and b/Writerside/images/completion_procedure.png differ diff --git a/Writerside/images/completion_procedure_dark.png b/Writerside/images/completion_procedure_dark.png new file mode 100644 index 0000000..a65beb0 Binary files /dev/null and b/Writerside/images/completion_procedure_dark.png differ diff --git a/Writerside/images/convert_table_to_xml.png b/Writerside/images/convert_table_to_xml.png new file mode 100644 index 0000000..2518a64 Binary files /dev/null and b/Writerside/images/convert_table_to_xml.png differ diff --git a/Writerside/images/convert_table_to_xml_dark.png b/Writerside/images/convert_table_to_xml_dark.png new file mode 100644 index 0000000..4716122 Binary files /dev/null and b/Writerside/images/convert_table_to_xml_dark.png differ diff --git a/Writerside/images/new_topic_options.png b/Writerside/images/new_topic_options.png new file mode 100644 index 0000000..bc6abb6 Binary files /dev/null and b/Writerside/images/new_topic_options.png differ diff --git a/Writerside/images/new_topic_options_dark.png b/Writerside/images/new_topic_options_dark.png new file mode 100644 index 0000000..bf3e48d Binary files /dev/null and b/Writerside/images/new_topic_options_dark.png differ diff --git a/Writerside/topics/starter-topic.md b/Writerside/topics/starter-topic.md new file mode 100644 index 0000000..7900754 --- /dev/null +++ b/Writerside/topics/starter-topic.md @@ -0,0 +1,89 @@ +# About Styleguide Remix Template + + + +## 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: + + + +

Start typing and select a procedure type from the completion suggestions:

+ completion suggestions for procedure + + +

Press Tab or Enter to insert the markup.

+ + + +## 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): + + + + ![Alt Text](new_topic_options.png){ width=450 } + + + + ]]> + + + +### 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 +Alt+Enter: + +Convert table to XML + +## Feedback and support + +Please report any issues, usability improvements, or feature requests to our +YouTrack project (you will need to +register). + +You are welcome to join our public Slack workspace. 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). + + + + Markup reference + Reorder topics in the TOC + Build and publish + Configure Search + + diff --git a/Writerside/v.list b/Writerside/v.list new file mode 100644 index 0000000..2d12cb3 --- /dev/null +++ b/Writerside/v.list @@ -0,0 +1,5 @@ + + + + + diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg new file mode 100644 index 0000000..2f58de1 --- /dev/null +++ b/Writerside/writerside.cfg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/app/routes/_index.tsx b/app/routes/_index.tsx index ba15143..1ef85ef 100644 --- a/app/routes/_index.tsx +++ b/app/routes/_index.tsx @@ -1,3 +1,6 @@ +/* eslint unicorn/filename-case: 0 */ + +/* eslint import/no-default-export: 0 */ import type { MetaFunction } from '@remix-run/node'; export const meta: MetaFunction = () => { diff --git a/package.json b/package.json index 654d6af..2261bb0 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "@commitlint/cli": "^19.0.3", "@commitlint/config-conventional": "^19.0.3", "@flydotio/dockerfile": "^0.5.9", - "@kurocado-studio/styleguide": "1.2.3-alpha.1", + "@kurocado-studio/styleguide": "1.2.3-alpha.2", "@remix-run/dev": "^2.8.1", "@types/react-dom": "^18.3.1", "autoprefixer": "^10.4.18", @@ -48,6 +48,6 @@ "vite": "^5.1.0" }, "engines": { - "node": ">=18.0.0" + "node": ">=20" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2d704bb..df3e72e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -49,8 +49,8 @@ importers: specifier: ^0.5.9 version: 0.5.9 '@kurocado-studio/styleguide': - specifier: 1.2.3-alpha.1 - version: 1.2.3-alpha.1(@commitlint/cli@19.5.0(@types/node@22.8.1)(typescript@5.6.3))(@commitlint/config-conventional@19.5.0)(@testing-library/jest-dom@6.6.2)(@testing-library/react@16.0.1(@testing-library/dom@10.4.0)(@types/react-dom@18.3.1)(@types/react@18.3.12)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@testing-library/user-event@14.5.2(@testing-library/dom@10.4.0))(@vitejs/plugin-react@4.3.3(vite@5.4.10(@types/node@22.8.1)))(eslint@8.57.1)(husky@9.1.6)(prettier@3.3.3)(semantic-release@23.1.1(typescript@5.6.3))(typescript@5.6.3)(vite@5.4.10(@types/node@22.8.1))(vitest-axe@0.1.0(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)))(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)) + specifier: 1.2.3-alpha.2 + version: 1.2.3-alpha.2(@commitlint/cli@19.5.0(@types/node@22.8.1)(typescript@5.6.3))(@commitlint/config-conventional@19.5.0)(@testing-library/jest-dom@6.6.2)(@testing-library/react@16.0.1(@testing-library/dom@10.4.0)(@types/react-dom@18.3.1)(@types/react@18.3.12)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@testing-library/user-event@14.5.2(@testing-library/dom@10.4.0))(@vitejs/plugin-react@4.3.3(vite@5.4.10(@types/node@22.8.1)))(eslint@8.57.1)(husky@9.1.6)(prettier@3.3.3)(semantic-release@23.1.1(typescript@5.6.3))(typescript@5.6.3)(vite@5.4.10(@types/node@22.8.1))(vitest-axe@0.1.0(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)))(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)) '@remix-run/dev': specifier: ^2.8.1 version: 2.13.1(@remix-run/react@2.13.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(typescript@5.6.3))(@remix-run/serve@2.13.1(typescript@5.6.3))(@types/node@22.8.1)(typescript@5.6.3)(vite@5.4.10(@types/node@22.8.1)) @@ -707,8 +707,8 @@ packages: '@jspm/core@2.1.0': resolution: {integrity: sha512-3sRl+pkyFY/kLmHl0cgHiFp2xEqErA8N3ECjMs7serSUBmoJ70lBa0PG5t0IM6WJgdZNyyI0R8YFfi5wM8+mzg==} - '@kurocado-studio/styleguide@1.2.3-alpha.1': - resolution: {integrity: sha512-8fi8UA1qTq5XSOs0v1ZBoxSog0KyHZ17x4cQahpLCiGQZBVWimaaoxn7ZckAYNjRCVQ9SKrIrKs+jk23ofez9Q==} + '@kurocado-studio/styleguide@1.2.3-alpha.2': + resolution: {integrity: sha512-1MCkDKtvMsuYCYzebf2IesbljM2520h+4lJAVREdBCTHkCN2rGR5mWdVwuVeWfQlh3tFxBeE8OvU6K88ogFgPA==} engines: {node: '>=20'} peerDependencies: '@commitlint/cli': ^19.0.3 @@ -4410,6 +4410,61 @@ packages: peerDependencies: typescript: '>4.0.0' + prettier-plugin-tailwindcss@0.6.8: + resolution: {integrity: sha512-dGu3kdm7SXPkiW4nzeWKCl3uoImdd5CTZEJGxyypEPL37Wj0HT2pLqjrvSei1nTeuQfO4PUfjeW5cTUNRLZ4sA==} + engines: {node: '>=14.21.3'} + peerDependencies: + '@ianvs/prettier-plugin-sort-imports': '*' + '@prettier/plugin-pug': '*' + '@shopify/prettier-plugin-liquid': '*' + '@trivago/prettier-plugin-sort-imports': '*' + '@zackad/prettier-plugin-twig-melody': '*' + prettier: ^3.0 + prettier-plugin-astro: '*' + prettier-plugin-css-order: '*' + prettier-plugin-import-sort: '*' + prettier-plugin-jsdoc: '*' + prettier-plugin-marko: '*' + prettier-plugin-multiline-arrays: '*' + prettier-plugin-organize-attributes: '*' + prettier-plugin-organize-imports: '*' + prettier-plugin-sort-imports: '*' + prettier-plugin-style-order: '*' + prettier-plugin-svelte: '*' + peerDependenciesMeta: + '@ianvs/prettier-plugin-sort-imports': + optional: true + '@prettier/plugin-pug': + optional: true + '@shopify/prettier-plugin-liquid': + optional: true + '@trivago/prettier-plugin-sort-imports': + optional: true + '@zackad/prettier-plugin-twig-melody': + optional: true + prettier-plugin-astro: + optional: true + prettier-plugin-css-order: + optional: true + prettier-plugin-import-sort: + optional: true + prettier-plugin-jsdoc: + optional: true + prettier-plugin-marko: + optional: true + prettier-plugin-multiline-arrays: + optional: true + prettier-plugin-organize-attributes: + optional: true + prettier-plugin-organize-imports: + optional: true + prettier-plugin-sort-imports: + optional: true + prettier-plugin-style-order: + optional: true + prettier-plugin-svelte: + optional: true + prettier@2.8.8: resolution: {integrity: sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==} engines: {node: '>=10.13.0'} @@ -6244,7 +6299,7 @@ snapshots: '@jspm/core@2.1.0': {} - '@kurocado-studio/styleguide@1.2.3-alpha.1(@commitlint/cli@19.5.0(@types/node@22.8.1)(typescript@5.6.3))(@commitlint/config-conventional@19.5.0)(@testing-library/jest-dom@6.6.2)(@testing-library/react@16.0.1(@testing-library/dom@10.4.0)(@types/react-dom@18.3.1)(@types/react@18.3.12)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@testing-library/user-event@14.5.2(@testing-library/dom@10.4.0))(@vitejs/plugin-react@4.3.3(vite@5.4.10(@types/node@22.8.1)))(eslint@8.57.1)(husky@9.1.6)(prettier@3.3.3)(semantic-release@23.1.1(typescript@5.6.3))(typescript@5.6.3)(vite@5.4.10(@types/node@22.8.1))(vitest-axe@0.1.0(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)))(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1))': + '@kurocado-studio/styleguide@1.2.3-alpha.2(@commitlint/cli@19.5.0(@types/node@22.8.1)(typescript@5.6.3))(@commitlint/config-conventional@19.5.0)(@testing-library/jest-dom@6.6.2)(@testing-library/react@16.0.1(@testing-library/dom@10.4.0)(@types/react-dom@18.3.1)(@types/react@18.3.12)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(@testing-library/user-event@14.5.2(@testing-library/dom@10.4.0))(@vitejs/plugin-react@4.3.3(vite@5.4.10(@types/node@22.8.1)))(eslint@8.57.1)(husky@9.1.6)(prettier@3.3.3)(semantic-release@23.1.1(typescript@5.6.3))(typescript@5.6.3)(vite@5.4.10(@types/node@22.8.1))(vitest-axe@0.1.0(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)))(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1))': dependencies: '@babel/core': 7.26.0 '@babel/eslint-parser': 7.25.9(@babel/core@7.26.0)(eslint@8.57.1) @@ -6293,6 +6348,7 @@ snapshots: prettier: 3.3.3 prettier-plugin-packagejson: 2.5.3(prettier@3.3.3) prettier-plugin-sort-imports: 1.8.6(typescript@5.6.3) + prettier-plugin-tailwindcss: 0.6.8(@trivago/prettier-plugin-sort-imports@4.3.0(prettier@3.3.3))(prettier-plugin-sort-imports@1.8.6(typescript@5.6.3))(prettier@3.3.3) semantic-release: 23.1.1(typescript@5.6.3) semantic-release-github-pullrequest: 1.3.0(semantic-release@23.1.1(typescript@5.6.3)) typescript: 5.6.3 @@ -6302,8 +6358,12 @@ snapshots: vitest: 2.1.3(@types/node@22.8.1)(jsdom@25.0.1) vitest-axe: 0.1.0(vitest@2.1.3(@types/node@22.8.1)(jsdom@25.0.1)) transitivePeerDependencies: + - '@ianvs/prettier-plugin-sort-imports' + - '@prettier/plugin-pug' + - '@shopify/prettier-plugin-liquid' - '@types/eslint' - '@vue/compiler-sfc' + - '@zackad/prettier-plugin-twig-melody' - bufferutil - canvas - encoding @@ -6312,6 +6372,16 @@ snapshots: - eslint-plugin-import-x - jest - monocart-coverage-reports + - prettier-plugin-astro + - prettier-plugin-css-order + - prettier-plugin-import-sort + - prettier-plugin-jsdoc + - prettier-plugin-marko + - prettier-plugin-multiline-arrays + - prettier-plugin-organize-attributes + - prettier-plugin-organize-imports + - prettier-plugin-style-order + - prettier-plugin-svelte - supports-color - utf-8-validate @@ -10623,6 +10693,13 @@ snapshots: prettier: 3.3.3 typescript: 5.6.3 + prettier-plugin-tailwindcss@0.6.8(@trivago/prettier-plugin-sort-imports@4.3.0(prettier@3.3.3))(prettier-plugin-sort-imports@1.8.6(typescript@5.6.3))(prettier@3.3.3): + dependencies: + prettier: 3.3.3 + optionalDependencies: + '@trivago/prettier-plugin-sort-imports': 4.3.0(prettier@3.3.3) + prettier-plugin-sort-imports: 1.8.6(typescript@5.6.3) + prettier@2.8.8: {} prettier@3.3.3: {}