Code Component

The Code component allows you to display code snippets within your application or documentation. It supports specifying the language and an optional title for better organization and clarity.

While the syntax is the same is with regular Markdown code blocks, Doctave supports additional features no available in most Markdown implementation.

const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
});

Attributes

The <Code> component can be customized using the following attributes and configuration.

Language and syntax highlighting

To activate syntax highlighting, add a language name after the three backticks (```).

defmodule MyApp.Server do
  def start(_type, _args) do
    IO.puts "Starting MyApp.Server"
  end
end

Title

You may also specify a title for the code block, which is displayed above the code.

You must specify a language for the title to be displayed. If you don't want syntax highlighting for the code block, you can use the plaintext language.

async function uploadFile(file: File, url: string): Promise<Response> {
  const formData = new FormData();
  formData.append('file', file);
  return fetch(url, { method: 'POST', body: formData });
}