diff --git a/code.mdx b/code.mdx deleted file mode 100644 index b137fcce0..000000000 --- a/code.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Code Blocks" -description: "Display inline code and code blocks" -icon: 'code' ---- - -## Basic - -### Inline Code - -To denote a `word` or `phrase` as code, enclose it in backticks (`). - -``` -To denote a `word` or `phrase` as code, enclose it in backticks (`). -``` - -### Code Block - -Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. - -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` - -````md -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` -```` - -Visit the [Code Block page](/content/components/code) for more detailed docs. diff --git a/hello/hi-there.mdx b/hello/hi-there.mdx new file mode 100644 index 000000000..957b66556 --- /dev/null +++ b/hello/hi-there.mdx @@ -0,0 +1,6 @@ +--- +title: 'New file' +description: 'Description of your new file.' +--- + +New file as well. \ No newline at end of file diff --git a/image-embeds.mdx b/image-embeds.mdx deleted file mode 100644 index 5c12f772b..000000000 --- a/image-embeds.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: 'Images, Videos, and Embeds' -description: 'Add image, video, and other HTML elements' -icon: 'image' ---- - - - - - Mintlify supports files up to 5 MB. To use larger files, consider a storage - service like Cloudinary and embed in your Mintlify documentation. - - -## Image - -### Using Markdown - -The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code - -```md -![title](/path/image.jpg) -``` - -Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed. - -### Using Embeds - -To get more customizability with images, you can also use embeds to add images. - -```html - -``` - -### Disable Image Zoom - -To disable the default zoom on click for images, add the noZoom property to image embeds. - -```html - -``` - -### Linking Images - -To link an image, for example to create a button on your docs, encompass the image in a link with the `noZoom` property. Images in `a` tags will automatically have a pointer cursor. - -```html - - - -``` - -### Dark Mode - -To use separate images for light and dark mode, use Tailwind CSS to hide and show images. - -```html - - -``` - -### Related - -For more information, we recommend the following sections: - - - Read the reference for the Frame component - - -## Videos - - - -
- - - -Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility. - - - -For YouTube videos use: - -```html - -``` - -For other videos, use: - -```html - -``` - -To autoplay the video, use: - -```html - -``` - - -Since Mintlify needs to adhere to the JSX syntax, double word attributes will need to -be written in camelCase: autoPlay, playsInline. - - -## iFrames - -Loads another HTML page within the document. - -```html - -``` - - - Although not required, we recommend adding the `alt` and `title` attributes to - images for better SEO and accessability. Learn more at [image - SEO](https://yoast.com/image-seo-alt-tag-and-title-tag-optimization/). - diff --git a/new-file.mdx b/new-file.mdx new file mode 100644 index 000000000..daf69345b --- /dev/null +++ b/new-file.mdx @@ -0,0 +1,6 @@ +--- +title: 'New file' +description: 'Description of your new file.' +--- + +New file for testing \ No newline at end of file diff --git a/web-editor.mdx b/web-editor.mdx index 0c945d94b..0333e5c37 100644 --- a/web-editor.mdx +++ b/web-editor.mdx @@ -22,17 +22,17 @@ changes, it's still helpful to know the basics of git. Git terminology: -- **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub). +* **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub). -- **Commit**: A snapshot of changes made to files in the repository. +* **Commit**: A snapshot of changes made to files in the repository. -- **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version. +* **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version. -- **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. +* **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. ### Making updates -In order to make updates to your docs, we include a few buttons specifically to +In order to make updates to your docs, we include a few buttons specifically to integrate with your git workflow. @@ -51,6 +51,7 @@ integrate with your git workflow. + @@ -59,6 +60,7 @@ integrate with your git workflow. + @@ -84,6 +86,7 @@ integrate with your git workflow. + @@ -95,6 +98,7 @@ integrate with your git workflow. + @@ -111,6 +115,7 @@ integrate with your git workflow. + @@ -125,6 +130,7 @@ commands you have access to after typing `/` in the **"Visual Editor"** mode: + @@ -132,6 +138,7 @@ As you type, you'll see more options pop up: + @@ -179,6 +186,7 @@ image or use an existing image from the repo. + @@ -186,6 +194,7 @@ Uploading an image can be done through the modal: + @@ -193,6 +202,7 @@ And you can preview an existing image before you add it. + @@ -203,6 +213,7 @@ and **"Edit"** buttons on the top right of the image. + @@ -210,6 +221,7 @@ Clicking the **"Edit"** button lets you edit the attributes of the image. + @@ -223,6 +235,7 @@ In order to offer the most flexibility, the editor has three modes: + @@ -239,10 +252,10 @@ you'd do in your IDE. This offers less flexibility, in that our components aren' for auto-complete, but it does have two unique advantages. 1. It allows you to edit props of components (see our [limitations below](#current-limitations)) -which is currently not available in **"Visual Editor"** mode yet. + which is currently not available in **"Visual Editor"** mode yet. 2. It allows you to correct syntax errors which might've appeared in your repo that -might not be compatible with **"Visual Editor"** mode until you've fixed them. + might not be compatible with **"Visual Editor"** mode until you've fixed them. ### Diff View @@ -263,8 +276,7 @@ We do have a few current limitations in the editor that we're working to resolve - We currently don't show any previews for custom snippets. This is on our roadmap to support - as fully editable components. + We currently don't show any previews for custom snippets. This is on our roadmap to support as fully editable components.