diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 1d88122..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Introduction to OpenQDA - -Let's discover **OpenQDA in under 10 minutes**. - -## Register a new account - -Head over to [the OpenQDA website at openqda.org](https://openqda.org). - -IMG -Click on the orange **Register** button. - -IMG -Now fill out the register form with your name or pseudonym, your email and a secure password. -Then click the **Register** button. - -IMG -A verification email should appear in your email program. Please click the link for verification. - -IMG -Now that you are verified, you can either edit your profile or create a project. - -## Create your first project - -Your work in OpenQDA is organized in projects. - -IMG -Fill out the project form and give Your first project a nice name (and optionally write a description). -Then click the **Create a new project** button. -Your new project is created, and you go to the project tab. If you want to go back and create more projects or switch between projects, click on the little blue owl in the left corner (this will change in the next version of OpenQDA, because it is not self-evident). - -## Manage your project - -You are now in the project tab of OpenQDA. Here you can change the project name, project description and even delete your project. -In the sub tab **Collaboration** you can set up your project to work with others. We skip this part for now. -In the sub tab **Codebook** you can manage different codebooks, share, reuse and import codebooks from other people. We skip this part also. -In the sub tab **History** you see a full log of all actions within the project. - -BTW, if you want to edit your profile picture, click on the profile picture in the right upper corner, right now it should be your initials, and select profile. Now you can select a new photo for your profile, change your name or password. - -## Upload and prepare a text file - -Let's upload and prepare our first text file for coding (right now, OpenQDA only supports RTF and TXT files - NO .doc, .docx or .pdf files!). -Please click on the **Preparation** tab at the top of the page. - -IMG -Now you can import TXT or RTF files into OpenQDA (as OpenQDA has a plug-in architecture, we or other people of the community may create import plug-ins for other file formats). -Click the **Import** button to select a TXT or RTF file. Click on the title of the document to see the contents of the file in the editor in the right pane. Now you can edit the document. - -You can also create new text documents when you click **New file**. You can then paste your text contents into the new document. - -When you are ready with editing, you can press the **Lock and Code** button to lock the file and start coding. - -## Coding the text - -Now you are in the **Coding** tab section. -In the left pane there is your text (you can switch between texts with the blue menu button). -On the right you see your codes pane. Right now you need to activate a codebook to start coding. -If you do not have any codes in your code book, let's create one by clicking on **Add Code**. -A new code category appears. You can edit it's name by double clicking on the text. -You can also create a note (click on the pen icon). -To create subcodes or move your codes, click on the mini-menu button of the code. -You can code text in 3 ways: -- make a text selection and use right mouse click / contextual menu click and select a code -- drag the text selection to the code -- drag the code to the text selection -All dragging only works on Macs and PCs, not on smartphones or tablets (we are working on it). - -## Analysis - -To do your analysis, go to the **Analysis** tab section. - -## What next? - -TBD diff --git a/docs/introduction/_category_.json b/docs/introduction/_category_.json new file mode 100644 index 0000000..6cd635d --- /dev/null +++ b/docs/introduction/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Introduction", + "position": 1, + "link": { + "type": "generated-index", + "description": "Registration, preparation, coding and analysis" + } +} diff --git a/docs/introduction/analysis.md b/docs/introduction/analysis.md new file mode 100644 index 0000000..99f98f4 --- /dev/null +++ b/docs/introduction/analysis.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 5 +--- +# Analysis + +When you are done coding one or more of your documents, you might want to get some help interpreting what you coded or have a deeper look into your coded sections. To do your analysis, go to the **Analysis** tab section on the top right of the screen. At the moment, OpenQDA offers three different analysis options. You can choose them from the drop-down menu on the top right, and they are: +- **List** Here you can list all your coded text snippets. Select all the documents and all the codes you want to include in your analysis, either by selectively checking each one individually or by clicking the "All files"/"All Codes" options. Your output on the left side of the screen will then contain all text sections that fulfill your selection criteria, structured by document. You can also export your result as a *.CSV file for further processing by clicking the **CSV** button in the top right corner. +- **Code Portrait** The code protrait gives you an overview of the code distribution in a document. As before, you can select codes and documents on the right hand side. Your output on the left will then show you the distribution of the selected codes over the selectes documents. Each instance is represented by a little square in the color of the code. +- **Word Cloud** The word cloud is a visualisation of the word distribution in your selection. As before, you select documents and codes, and the word cloud shows you which words occur most or least frequently in your selection, by displaying them larger or smaller. You also have some adjustment options concerning the presentation as well as the words included. + +And that's it, you now know the basics of OpenQDA. If you have any questions, encounter any bugs, have ideas for improvements or features, you can always visit us on Github at [github.com/openqda](https://github.com/openqda "github.com/openqda") and write [feedback](https://github.com/openqda/feedback) there or write us an email at [openqda@uni-bremen.de](mailto:openqda@uni-bremen.de) + +## What next? + +We are constantly working on improvements to OpenQDA or implementing new features and functions, to get an overview over what is planned next, you can check out our [milestones](https://github.com/openqda/openqda/milestones), where you are of course also invited to contribute. diff --git a/docs/introduction/coding.md b/docs/introduction/coding.md new file mode 100644 index 0000000..67ee804 --- /dev/null +++ b/docs/introduction/coding.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 4 +--- + +# Coding the text + +By clicking the **Lock and Code** button at the document preparation or simply by clicking the **Coding** tab (the third one from the left) on the top of your screen you get to the **Coding** section. + +On the left hand side you see your document (you can switch between locked documents with the blue menu button). +On the right hand side is your codebook (or code system/code tree/code collection/...). To start coding, you need to activate at least one codebook. You can do that by clicking the little cog wheel and then select one of the available codebooks. + +Since we only created one codebook when we created the project, we just choose that one. + +![Activating a codebook](../../static/img/selecting_codebook_96dpi.png "Activating a codebook") + +If you do not have any codes in your code book, you can create them by clicking on **+ Add Code**. A new code with a radomly created name and color appears. You can edit its name by double clicking on the text and you can change the color via the menu that opens by clicking the three vertical dots on the right side of each code. The color change is the first entry. + +![Changing the color of a code](../../static/img/changing_code_color_96dpi.png "Changing the color") + +You can also find the options to create subcodes or move your codes around in that same menu. + +If you would like to create a note (or memo) for a code, simply click the little notepad icon next to the name of the code. This opens a little yellow "Post It" note for your text. + +There are three different ways to code text in OpenQDA: +- making a text selection by highlighting it with the pressed left mouse button and use **right mouse click** to open a contextual menu and then click on the desired a code for the highlighted text +- making a text selection by highlighting it with the pressed left mouse button and then clicking and holding the selection with the left mouse button and **dragging it** to onto the desired code on the right +- making a text selection by highlighting it with the pressed left mouse button and then **dragging the desired code** from the coding system onto the selected text + +> :bulb: **Tip:** You don't actually have to "aim" for your text selection, it's enough to drag the code anywhere in your document. + +> :exclamation: **Please note** Please be aware that all options involving dragging only work on Macs and PCs, not on smartphones or tablets (we are working on it). diff --git a/docs/introduction/preparation.md b/docs/introduction/preparation.md new file mode 100644 index 0000000..ca848b8 --- /dev/null +++ b/docs/introduction/preparation.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 3 +--- + +# Upload and prepare a text file + +Great work on creating your first project! But that project is still empty. To change that, let's upload our first text file and prepare it for coding. To do so, switch to the "Preparation" tab. That's the second tab from the left on top of your screen. + +> :exclamation: **Please note** At the moment, OpenQDA only supports *.RTF and *.TXT files. Other common file formats, like *.DOC, *.DOCX or *.PDF files might be supported at a later date. OpenQDA has a plug-in architecture: We, you, or other people in the community are able create import plug-ins for other file formats. + +Now, to upload an existing file, click the **Import** button to select a *.TXT or *.RTF file. Click on the title of the document to see the contents of the file in the editor in the right pane. Now you can edit the document and prepare it for coding, if necessary. + +![Importing a document file into OpenQDA](../../static/img/document_selection_96dpi.png "Importing a document file") + +The editor works just like any word processor you know. Here you can add or delete text and also format the text according to your needs. Don't forget to click the **Save** button above the text to make your changes permanent. This way you can even create documents directly in OpenQDA. Just click the **New File** butten next to the **Import** button on the top left. You can then type or paste your text contents (for example from a *.PDF file) into the newly created document. Again, don't forget to save your work. +If you click on the three little dots next to a file name, you can also rename the document or delete it from your project. + +When you are done editing your file, you can press the **Lock and Code** button to lock the file and start coding. + +> :exclamation: **Please note** Please be aware that once you started coding a document, you can not unlock it anymore to make further edits. Once coding started, editing ends. + +![Editing a document file in OpenQDA](../../static/img/document_preparation_96dpi.png "Editing a document file") \ No newline at end of file diff --git a/docs/introduction/projects.md b/docs/introduction/projects.md new file mode 100644 index 0000000..e8e96a5 --- /dev/null +++ b/docs/introduction/projects.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 2 +--- + +# Create your first project + +Your work in OpenQDA is organized in projects. + +Fill out the project form and give your first project a nice name (and optionally write a description, for example your research question). +Then click the **Create a new project** button. +Your new project is created, and you go to the project tab. If you want to go back and create more projects or switch between projects, click on Qudi, the little blue owl, in the left corner (this will change in the next version of OpenQDA, because it is not self-evident). + +![Create a new project in OpenQDA](../../static/img/create_project_96dpi.png "Creating a new project") + +## Manage your project + +OpenQDA is organized in four different tabs oriented on the workflow of a typical QDA project. Those tabs are "Project", "Preparation", "Coding" and "Analysis", and you find them at the top of your screen. When you create a new project, you will find yourself at first in the "Project" tab of OpenQDA. Here, in the **Overview** you can update the project name or project description of your project and even delete your project. + +In the sub tab **Collaboration** you can set up your project to work with others. We skip this part for now. + +In the sub tab **Codebook** you can manage different codebooks, share, reuse and import codebooks from other people. To create an empty codebook for your project, simply enter a name and optionally a description and click the blue "Create" button. + +> :exclamation: **Please note:** OpenQDA gives you the option to share your codebooks with other users of the platform. To do so, click the little checkbox next to "Shared with public" when creating your codebook. It will then appear in the **Public Codebooks** section and others can import a copy of it into their projects. This will not have any effect on the codebook in *your* project. + +In the sub tab **History** you see a full log of all actions within the project. + +> :bulb: **Tip:** BTW, if you want to edit your profile picture, click on the profile picture in the upper right corner of the screen (at the moment it should just be your initials) and select "Profile". Now you can select a new photo for your profile by uploading it from your hard drive. You can also change your name or password.. diff --git a/docs/introduction/registration.md b/docs/introduction/registration.md new file mode 100644 index 0000000..0025a17 --- /dev/null +++ b/docs/introduction/registration.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 1 +--- + +# Register a new account + +Head over to [the OpenQDA website at openqda.org](https://openqda.org). + +Click on the orange **Register** button. +![Register to OpenQDA](../../static/img/register_96dpi.png "Register Button") + +Now fill out the register form with your name or pseudonym, your email and a secure password. +Then confirm that you are not a robot (to your knowledge) and click the **Register** button. + +> :bulb: **Tip:** While currently it is only required that your password consists of a minimum of eight characters, we recommend using a mix of letters, numbers and special characters. + +![Register to OpenQDA](../../static/img/register_filled_96dpi.png "Register your account") + +> :postbox: A verification email should have been sent to the email address you provided - please open it and click the link to verify your email address and complete the registration process. + +Now that you are verified, you can log into OpenQDA with your mail address and password and start using the software by either editing your profile or creating a new project for data analysis. diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55..0000000 --- a/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/tutorial-basics/congratulations.md b/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/tutorial-basics/create-a-blog-post.md b/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/tutorial-basics/create-a-page.md b/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

-
- ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/tutorial-basics/deploy-your-site.md b/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 35e0082..0000000 --- a/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/tutorial-extras/img/localeDropdown.png b/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index ccda0b9..0000000 --- a/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/tutorial-extras/translate-your-site.md b/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index b5a644a..0000000 --- a/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/src/pages/imprint.md b/src/pages/imprint.md index a937c88..d4d030c 100644 --- a/src/pages/imprint.md +++ b/src/pages/imprint.md @@ -10,7 +10,7 @@ Linzer Str. 4
## Contact -E-Mail: OpenQDA@uni-bremen.de +E-Mail: openqda@uni-bremen.de Responsible for the content according to § 55 Abs. 2 RStV
Florian Hohmann diff --git a/src/pages/index.js b/src/pages/index.js index b0dc2a6..ae55424 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -19,7 +19,7 @@ function HomepageHeader() {
+ to="/docs/category/introduction"> Introduction Tutorial - 5min ⏱️
diff --git a/static/img/changing_code_color_96dpi.png b/static/img/changing_code_color_96dpi.png new file mode 100644 index 0000000..a8ebbeb Binary files /dev/null and b/static/img/changing_code_color_96dpi.png differ diff --git a/static/img/create_project_96dpi.png b/static/img/create_project_96dpi.png new file mode 100644 index 0000000..a1b986a Binary files /dev/null and b/static/img/create_project_96dpi.png differ diff --git a/static/img/document_preparation_96dpi.png b/static/img/document_preparation_96dpi.png new file mode 100644 index 0000000..9f0f667 Binary files /dev/null and b/static/img/document_preparation_96dpi.png differ diff --git a/static/img/document_selection_96dpi.png b/static/img/document_selection_96dpi.png new file mode 100644 index 0000000..1625764 Binary files /dev/null and b/static/img/document_selection_96dpi.png differ diff --git a/static/img/register_96dpi.png b/static/img/register_96dpi.png new file mode 100644 index 0000000..6ebaf1a Binary files /dev/null and b/static/img/register_96dpi.png differ diff --git a/static/img/register_filled_96dpi.png b/static/img/register_filled_96dpi.png new file mode 100644 index 0000000..a58de70 Binary files /dev/null and b/static/img/register_filled_96dpi.png differ diff --git a/static/img/selecting_codebook_96dpi.png b/static/img/selecting_codebook_96dpi.png new file mode 100644 index 0000000..af1bc7a Binary files /dev/null and b/static/img/selecting_codebook_96dpi.png differ