Project: YugabyteDB (App Definition and Development / Database)
File: all-page-elements.md

title: Contribute - page with elements headerTitle: Page with elements linkTitle: Page with elements headcontent: Just about every page element on a single page description: YugabyteDB Documentation page elements on a single page. layout: single type: docs menu: preview: identifier: all-page-elements parent: docs-edit weight: 9000 This page demonstrates styles and widgets used for the YugabyteDB Documentation site. To view the source for the file, click Contribute and choose Edit this page. <ul class="nav nav-tabs-alt nav-tabs-yb"> <li class="active"> <a href="../all-page-elements/" class="nav-link"> <img src="/icons/cloud.svg" alt="Icon"> Top-level Tab Widget </a> </li> <li> <a href="../all-page-elements/" class="nav-link"> <img src="/icons/server.svg" alt="Icon"> Tab 2 </a> </li> </ul> This is a top-level tab widget, that uses different files for each tab. Everything that follows is in this tab's file. If you change tabs, you get a whole new page. <ul class="nav nav-tabs-alt nav-tabs-yb"> <li class="active"> <a href="../all-page-elements/" class="nav-link"> <i class="fa-brands fa-apple" aria-hidden="true"></i> macOS </a> </li> <li> <a href="../all-page-elements/" class="nav-link"> <i class="fa-brands fa-linux" aria-hidden="true"></i> Linux </a> </li> <li> <a href="../all-page-elements/" class="nav-link"> <i class="fa-brands fa-docker" aria-hidden="true"></i> Docker </a> </li> <li> <a href="../all-page-elements/" class="nav-link"> <i class="fa-regular fa-dharmachakra" aria-hidden="true"></i> Kubernetes </a> </li> </ul> This is a second-level tab widget, that uses different files for each tab - same as the one above, just styled differently. Everything that follows is in this tab's file. If you change tabs, you get a whole new page. This tab widget doesn't use separate files to fill in the content and then link between. Here the content is placed inside the `tabpane` shortcode. {{< tabpane text=true >}} {{% tab header="Tab" lang="java" %}} Another tab style; here all the tab contents are in-page. To build and run the application, do the following: Clone the sample application to your computer: ```sh git clone https://github.com/YugabyteDB-Samples/yugabyte-simple-java-app.git && cd yugabyte-simple-java-app ``` Provide connection parameters. The application needs to establish a connection to the YugabyteDB cluster. To do this: Set the following connection parameters: host - the host name of your YugabyteDB cluster. To obtain a YugabyteDB Managed cluster host name, sign in to YugabyteDB Managed, select your cluster on the Clusters page, and click Settings. The host is displayed under Connection Parameters. port - the port number that will be used by the JDBC driver (the default YugabyteDB YSQL port is 5433). Save the file. The end of this tab. {{% /tab %}} {{% tab header="Another tab" lang="go" %}} The contents of the next tab. You can keep adding tabs in similar fashion. To build and run the application, do the following: Clone the sample application to your computer: ```sh git clone https://github.com/YugabyteDB-Samples/yugabyte-simple-go-app.git && cd yugabyte-simple-go-app ``` Provide connection parameters. {{% /tab %}} {{< /tabpane >}} These pills automatically re-flow based on page width; just keep adding list items. Use these pills for landing pages or as an alternative to tabs. <ul class="nav yb-pills"> <li> <a href="../../../tutorials/build-apps/java/cloud-ysql-yb-jdbc/" class="orange"> <i class="fa-brands fa-java"></i> Java </a> </li> <li> <a href="../../../tutorials/build-apps/go/cloud-ysql-go/" class="orange"> <i class="fa-brands fa-golang"></i> Go </a> </li> <li> <a href="../../../tutorials/build-apps/python/cloud-ysql-python/" class="orange"> <i class="fa-brands fa-python"></i> Python </a> </li> <li> <a href="../../../tutorials/build-apps/nodejs/cloud-ysql-node/" class="orange"> <i class="fa-brands fa-node-js"></i>

</a> </li> </ul> The following is a basic markdown table. | Table | A column | | :- | :- | | A row | Another column in a table. Maybe to describe stuff. Might have bulleted lists etc, but that all has to be done using HTML. | | Another row | Another row in a table. | | Another row | Another column in a table. | An ordinary paragraph. Blockquote Blockquote text Some more blockquote text. {{< note title="Note" >}} This is an actual Note. Pay special attention to this thing, maybe. {{< /note >}} {{< tip title="Tip" >}} This is an actual Tip. Maybe there's a cool alternative to what you are doing. {{< /tip >}} {{< warning title="Warning" >}} This is an actual Warning. Whatever you are doing may threaten your data if you do it wrong. {{< /warning >}} What follows is an image: What follows is an embedded YouTube video: {{< youtube id="qYMcNzWotkI" title="Deploy a fault tolerant cluster in YugabyteDB Managed" >}} What follows are some numbered steps, some code, text indented under a step: Numbered list with indented lists. Second level numbered list indent. Second level numbered list indent. Third level numbered list indent. Third level numbered list indent. Second list item. Some text in bold. Some text in italics. Third list item. Indented text under a list. ```output Some code ``` Fourth list item. Bulleted lists with levels of indent: Bulleted list with indented lists. Second level Bulleted list indent. Second level Bulleted list indent. Third level Bulleted list indent. Third level Bulleted list indent. Some bullets: a cluster deployed in YugabyteDB Managed. the cluster CA certificate; YugabyteDB Managed uses TLS to secure connections to the database. your computer added to the cluster IP allow list. Refer to . Glossary term : Definition. This text is a definition for a glossary term, or any sort of definition list. Glossary term : Definition. This text is a definition for a glossary term, or any sort of definition list. : Another paragraph in the definition. Glossary term : Definition. This text is a definition for a glossary term, or any sort of definition list. : Another paragraph in the definition. The details HTML tag is used to create an interactive widget that the user can open and close. By default, the widget is closed. When open, it expands, and displays the contents. <details> <summary>Long code block</summary> These contents might be a very long bit of code or somesuch. </details> ```sh ysqlsh [ <option>...] [ <dbname> [ <username> ]] ``` Once in awhile, there is a horizontal rule. Flags are documented often using a heading 5. Heading 5 doesn't show up in right navigation. We probably wouldn't want it to, as there can be dozens of these flags on some pages. Heading 5 is used so that we can deep-link to the flag. This is a paragraph. {{% readfile "include-file.md" %}} {{% includeMarkdown "include-markdown.md" %}} have Grammar/Diagram pairs. They use a special code (`ebnf`) to display the appropriate grammar and diagrams. {{%ebnf%}} copy_from, copy_to, copy_option {{%/ebnf%}}