Skip to main content
Version: 2.1.0

FAQ

This section is meant to address and document common questions, mistakes, errors, and pitfalls that people might run into.

Example: How do I directly access my local development database?​

When running the dev-containers, add an override file with port mappings to allow your database client to connect to the database running in the Docker network.

name: aoh

serivces:
    my-module-db:
        5500:5432

Include the override file when you up your compose file.

docker compose --env-file .env -f iams/compose.yml -f override.yml up -d

Example: How can I grow a bigger chest?​

Do more chest exercises such as:

  • Bench Press
  • Dips
  • Seated Chest Press

Gradually increase the number of sets you do each week.

Gists​

If necessary and separate from the FAQ section, you can provide lists of commands, code recipes etc. here for users to copy-paste. These should be very short sections.

The gists below is a set of useful Docusaurus references to help you with writing your documentation for Docusaurus and is itself a good example of what gists should be.

Docusaurus Reference​

The following is a list of useful examples for reference when editing the markdown files on Docusaurus.

note

Formatting is very important for MDX: https://github.com/facebook/docusaurus/issues/3890 You must follow the formatting somewhat strictly (especially excluding spaces at the start of the sentence).

Images​

Svelte Logo

Code to render above example:

![Svelte Logo](/img/sample.png)

Tabs​

shutdown -t 0 -s

Code to render above example:

<!-- You must import the React components -->

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="Windows" label="Windows" default>

```bash
shutdown -t 0 -s
```

</TabItem>
<TabItem value="macOS" label="macOS">

```bash
sudo shutdown -h now
```

</TabItem>
<TabItem value="Linux" label="Linux">

```bash
sudo shutdown -h now
```

</TabItem>
</Tabs>

Codeblocks​

/src/components/HelloCodeTitle.js
function HelloCodeTitle(props) {
	return <h1>Hello, {props.name}</h1>;
}

Code to render above example:

```jsx title="/src/components/HelloCodeTitle.js"
function HelloCodeTitle(props) {
	return <h1>Hello, {props.name}</h1>;
}
```

Equations​

$$ I = \int_0^{2\pi} \sin(x),dx $$

Code to render above example:

$$
I = \int_0^\{2\pi\} \sin(x)\,dx
$$

Admonitions​

note

Some content with Markdown syntax. Check this api.

tip

Some content with Markdown syntax. Check this api.

info

Some content with Markdown syntax. Check this api.

caution

Some content with Markdown syntax. Check this api.

danger

Some content with Markdown syntax. Check this api.

Code to render above examples:

:::note

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::tip

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::info

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::caution

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

:::danger

Some **content** with _Markdown_ `syntax`. Check [this `api`](#).

:::

Line Highlighting​

function HighlightSomeText(highlight) {
	if (highlight) {
		return "This text is highlighted!";
	}

	return "Nothing highlighted";
}

function HighlightMoreText(highlight) {
	if (highlight) {
		return "This range is highlighted!";
	}

	return "Nothing highlighted";
}

Code to render above example:

```js
function HighlightSomeText(highlight) {
	if (highlight) {
		// highlight-next-line
		return "This text is highlighted!";
	}

	return "Nothing highlighted";
}

function HighlightMoreText(highlight) {
	// highlight-start
	if (highlight) {
		return "This range is highlighted!";
	}
	// highlight-end

	return "Nothing highlighted";
}
```

Line Numbering​

import React from "react";

function MyComponent(props) {
	if (props.isBar) {
		return <div>Bar</div>;
	}

	return <div>Foo</div>;
}

export default MyComponent;

Code to render above example:

```jsx {1,4-6,11} showLineNumbers
import React from "react";

function MyComponent(props) {
	if (props.isBar) {
		return <div>Bar</div>;
	}

	return <div>Foo</div>;
}

export default MyComponent;
```