Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vilkinsons authored Aug 24, 2023
1 parent 36d8fd8 commit eaead5e
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions apps/hashdotai/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
[`docs`]: https://github.com/hashintel/hash/tree/main/apps/hashdotai/docs
[`glossary`]: https://github.com/hashintel/hash/tree/main/apps/hashdotai/glossary
[`internal` monorepo]: https://github.com/hashintel/internal
[contributing]: https://github.com/hashintel/hash/blob/main/.github/CONTRIBUTING.md
[hash.ai]: https://hash.ai/?utm_medium=organic&utm_source=github_readme_hashdotai
[hash.ai/docs]: https://hash.ai/docs?utm_medium=organic&utm_source=github_readme_hashdotai
[hash.ai/glossary]: https://hash.ai/glossary?utm_medium=organic&utm_source=github_readme_hashdotai
[mdx]: https://mdxjs.com/?utm_source=hash&utm_medium=github&utm_id=hashdotai&utm_content=readme-file


# `hashdotai`

## Overview

The [hash.ai](https://hash.ai) website code currently resides in our private [`internal` monorepo](https://github.com/hashintel/internal). However, certain site content is made publicly editable and available under Creative Commons/open-source licenses.
The [hash.ai] website code currently resides in our private [`internal` monorepo]. However, certain site content is made publicly editable and available under Creative Commons/open-source licenses.

- **User Guide** ([hash.ai/docs](https://hash.ai/docs)): found in this repository under the [`docs`](https://github.com/hashintel/hash/tree/main/apps/hashdotai/docs) directory
- **Glossary Definitions** ([hash.ai/glossary](https://hash.ai/glossary)): found in this repository under the [`glossary`](https://github.com/hashintel/hash/tree/main/apps/hashdotai/glossary) directory
- **User Guide** ([hash.ai/docs]): found in this repository under the [`docs`] directory
- **Glossary Definitions** ([hash.ai/glossary]): found in this repository under the [`glossary`] directory

Other hash.ai website content will be migrated here in due course.

## MDX file format

Our resources are written in [MDX](https://mdxjs.com/), a format which allows for using JSX tags in Markdown documents.
Our resources are written in [MDX], a format which allows for using JSX tags in Markdown documents.

This has the same syntax as Markdown documents, except for special tags we use to highlight certain elements, which you can see examples of in existing documents.

There is currently an issue with code blocks inside of Custom MDX components, eg, `Tabs` or `Hint`. There needs to be a new line before any code block (ie, text preceded by backticks ```) so that the code inside isn't interpreted as JSX by the MDX parser. This issue should be fixed by improvements to the parser documented in the `mdx-js` repo here: https://github.com/mdx-js/mdx/issues/1041
There is currently an issue with code blocks inside of Custom MDX components, eg, `Tabs` or `Hint`. There needs to be a new line before any code block (ie, text preceded by backticks ```) so that the code inside isn't interpreted as JSX by the MDX parser. This issue should be fixed by improvements to the parser documented in the `mdx-js` repo (https://github.com/mdx-js/mdx/issues/1041) which were introduced in MDX v2. However, there are issues between MDX v2 and Prettier (https://github.com/prettier/prettier/issues/12209) preventing our adoption.

0 comments on commit eaead5e

Please sign in to comment.