Skip to main content

样例参考文档

代码块​

基本使用 JSX​

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

基本使用 C​

main.c
/** @defgroup GPIO_Exported_Functions_Group2 IO operation functions
 *  @brief   GPIO Read and Write
 *
@verbatim
 ===============================================================================
                       ##### IO operation functions #####
 ===============================================================================
  [..]
    This subsection provides a set of functions allowing to manage the GPIOs.

@endverbatim
  * @{
  */

/**
  * @brief  Reads the specified input port pin.
  * @param  GPIOx: where x can be (A..G depending on device used) to select the GPIO peripheral
  * @param  GPIO_Pin: specifies the port bit to read.
  *         This parameter can be GPIO_PIN_x where x can be (0..15).
  * @retval The input port pin value.
  */
GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
{
  GPIO_PinState bitstatus;

  /* Check the parameters */
  assert_param(IS_GPIO_PIN(GPIO_Pin));

  if ((GPIOx->IDR & GPIO_Pin) != (uint32_t)GPIO_PIN_RESET)
  {
    bitstatus = GPIO_PIN_SET;
  }
  else
  {
    bitstatus = GPIO_PIN_RESET;
  }
  return bitstatus;
}

高亮代码​

function HighlightSomeText(highlight) {
  if (highlight) {
    return "这行被高亮了！";
  }

  return "这里不会";
}

function HighlightMoreText(highlight) {
  if (highlight) {
    return "这块被高亮了！";
  }

  return "这里不会";
}

高亮代码直接指定行号​

import React from "react";

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

  return <div>Foo</div>;
}

export default MyComponent;

带行号​

import React from "react";

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

  return <div>Foo</div>;
}

export default MyComponent;

告示​

note1

Some content with Markdown syntax. Check this api.

tip1

Some content with Markdown syntax. Check this api.

info1

Some content with Markdown syntax. Check this api.

warning1

Some content with Markdown syntax. Check this api.

danger1

Some content with Markdown syntax. Check this api.

嵌套​

Parent

Parent content

Child

Child content

Deep Child

Deep child content

带TAG​

Use tabs in admonitions

This is an apple 🍎

Diagrams​

https://github.com/mermaid-js/mermaid

数学公式​

https://katex.org/

有问题

文档链接​