1.14.4

Translate

siteConfig.js

Grande parte da configuração do site é feita a partir da edição do arquivo siteConfig.js.

Vitrine de usuários

O array users é usado para armazenar objetos para cada projeto/usuário que você queira mostrar no seu site. Atualmente, este campo é usado pelos arquivos de exemplo pages/en/index.js e pages/en/users.js. Cada objeto de usuário deve ter os campos caption, image, infoLink e pinned. caption é o texto mostrado quando alguém passa o ponteiro do mouse por cima da imagem (image) daquele usuário, e o campo infoLink é para onde as pessoas serão levadas ao clicar na imagem. O campo pinned determina se a imagem aparecerá ou não na página index.

Atualmente, este array users é usado apenas pelos arquivos de exemplo index.js e users.js. Caso não deseje ter uma página de usuários nem mostrar usuários na página index, você pode remover esta seção.

Campos do siteConfig

O objeto siteConfig contém a maioria dos ajustes de configuração do seu site.

Campos obrigatórios

baseUrl [string]

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. Para URLs que não têm caminho, o baseUrl deve ser definido para /. This field is related to the url field.

colors [object]

Color configurations for the site.

  • primaryColor é a cor usada no menu superior de navegação e nas barras laterais.
  • secondaryColor é a cor vista na segunda linha do menu de navegação quando a janela do site estiver estreita (incluindo na versão móvel).
  • Cores personalizadas também podem ser configuradas. Por exemplo, se o estilo que o usuário estiver adicionando com as cores especificadas em $myColor, então adicionar o campo myColor para colors, permitirá que você configure esta cor.

copyright [string]

A string de direitos autorais no rodapé do site e dentro do feed

favicon [string]

URL for site favicon.

headerIcon [string]

URL usada na barra de navegação do cabeçalho.

headerLinks [array]

Links que serão utilizados na barra de navegação do cabeçalho. O campo label de cada objeto será o texto do link e também será traduzido para cada idioma.

Exemplo de uso:

headerLinks: [
  // Link para o documento com o id doc1 no idioma/versão atuais
  { doc: "doc1", label: "Getting Started" },
  // Link para a página encontrada em pages/en/help.js ou, se ela não existir, pages/help.js, no idioma atual
  { page: "help", label: "Help" },
  // Link para um URL absoluto
  { href: "https://github.com/", label: "GitHub" },
  // Link para o blog gerado pelo Docusaurus (${baseUrl}blog)
  { blog: true, label: "Blog" },
  // Determina a posição da barra de pesquisa em meio aos links
  { search: true },
  // Determina o menu seletor de idioma em meio aos links
  { languages: true }
],

organizationName [string]

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

projectName [string]

Nome do projeto. Isso deve corresponder ao nome do projeto do seu repositório GitHub (diferencia maiúsculas de minúsculas).

tagline [string]

A tagline para o seu site.

title [string]

Título para o seu site.

url [string]

URL para o seu site. This can also be considered the top-level hostname. Por exemplo, https://facebook.github.io é a URL do https://facebook.github.io/metro/, e https://docusaurus.io é a URL para https://docusaurus.io. This field is related to the baseUrl field.

Campos opcionais

algolia [object]

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

  • apiKey - o Algolia forneceu uma chave de API para a sua pesquisa.
  • indexName - o nome de índice fornecido pelo Algolia para a sua pesquisa (que geralmente é o nome do projeto).
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.

blogSidebarCount [number]

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

blogSidebarTitle [string]

Control the title of the blog sidebar. See the adding a blog docs for more information.

limparUrl [boolean]

Se verdade, permita URLs sem a extensão HTML. Por exemplo, um pedido para a URL https://docusaurus.io/docs/installation retornará o mesmo resultado que https://docusaurus.io/docs/installation.html.

Se os usuários pretendem que este site seja usado exclusivamente offline, este valor deve ser definido para false. Caso contrário, ele fará com que o site siga para a pasta pai da página vinculada.

cname [string]

The CNAME for your website. It will go into a CNAME file when your site is built.

customDocsPath [string]

By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field.

customDocsPath: 'docs/site';

customDocsPath: 'website-docs';

defaultVersionShown [string]

The default version for the site to be shown. If this is not set, the latest version will be shown.

docsUrl [string]

A URL base para todos os arquivos de documentação. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

disableHeaderTitle [boolean]

An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true.

disableTitleTagline [boolean]

An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

docsSideNavCollapsible [boolean]

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

editUrl [string]

URL for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

enableUpdateBy [boolean]

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

enableUpdateTime [boolean]

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

facebookAppId [string]

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

facebookComments [boolean]

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

facebookPixelId [string]

Facebook Pixel ID to track page views.

fonts [object]

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

fonts: {
  minhaFonte: [
    'Times New Roman',
    'Serif'
  ],
  outraFonte: [
    '-apple-system',
    'system-ui'
  ]
},

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

h1 {
  font-family: $minhaFonte;
}

footerIcon [string]

URL for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

gaTrackingId [string]

Google Analytics tracking ID to track page views.

gaGtag [boolean]

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

githubHost [string]

The hostname of your server. Useful if you are using GitHub Enterprise.

highlight

Syntax highlighting options:

{
  // ...
  highlight: {
    // The name of the theme used by Highlight.js when highlighting code.
    // You can find the list of supported themes here:
    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
    theme: 'default',

    // The particular version of Highlight.js to be used.
    version: '9.12.0',

    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    hljs: function(highlightJsInstance) {
      // do something here
    },

    // Default language.
    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
    // https://github.com/isagalaev/highlight.js/tree/master/src/languages

    defaultLang: 'javascript',

    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
    themeUrl: 'http://foo.bar/custom.css'
  },
}

manifest [string]

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

opcoesMarkdown [object]

Override default Remarkable options that will be used to render markdown.

To manage syntax extensions, use the markdownPlugins field.

markdownPlugins [array]

An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

  markdownPlugins: [
    function foo(md) {
      md.inline.ruler.enable(['sub', 'sup']);
    },
  ],

noIndex [boolean]

Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.

ogImage [string]

Local path to an Open Graph image (e.g., img/myImage.png). Esta imagem será exibida quando seu site for compartilhado no Facebook e outros sites/apps onde o protocolo Open Graph é suportado.

onPageNav [string]

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

scripts [array]

An array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

separarCss [array]

Directories inside which any CSS files will not be processed and concatenated to Docusaurus' styles. This is to support static HTML pages that may be separate from Docusaurus with completely separate styles.

scrollToTop [boolean]

Set this to true if you want to enable the scroll to top button at the bottom of your site.

scrollToTopOptions [object]

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

stylesheets [array]

An array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

translationRecruitingLink [string]

URL for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

twitter [boolean]

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

twitterUsername [string]

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

twitterImage [string]

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

useEnglishUrl [string]

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

users [array]

The users array mentioned earlier.

usePrism [array]

An array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

wrapPagesHTML [boolean]

Boolean flag to indicate whether HTML files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being HTML fragments instead of complete pages. It inserts the contents of your HTML file with no extra processing. Defaults to false.

Users can also add their own custom fields if they wish to provide some data across different files.

Adicionando Google Fonts

Google Fonts oferece tempos de carga mais rápidos, cache de fontes sem forçar os usuários a sacrificar a privacidade. Para obter mais informações sobre o Google Fonts, consulte a documentação Google Fonts.

Para adicionar Google Fonts à sua implantação do Docusaurus, adicione o caminho de fonte para siteConfig.js sob stylesheets:

stylesheets: [
  'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,700',
],

Examplo de siteConfig.js com vários campos disponíveis

const users = [
  {
    caption: 'User1',
    image: '/test-site/img/docusaurus.svg',
    infoLink: 'https://www.example.com',
    pinned: true,
  },
];

const siteConfig = {
  title: 'Docusaurus',
  tagline: 'Generate websites!',
  url: 'https://docusaurus.io',
  baseUrl: '/',
  // For github.io type URLS, you would combine the URL and baseUrl like:
  // url: 'https://reasonml.github.io',
  // baseUrl: '/reason-react/',
  defaultVersionShown: '1.0.0',
  organizationName: 'facebook',
  projectName: 'docusaurus',
  noIndex: false,
  // For no header links in the top nav bar -> headerLinks: [],
  headerLinks: [
    {doc: 'doc1', label: 'Docs'},
    {page: 'help', label: 'Help'},
    {search: true},
    {blog: true},
  ],
  headerIcon: 'img/docusaurus.svg',
  favicon: 'img/favicon.png',
  colors: {
    primaryColor: '#2E8555',
    secondaryColor: '#205C3B',
  },
  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
  // Users variable set above
  users,
  disableHeaderTitle: true,
  disableTitleTagline: true,
  separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'],
  footerIcon: 'img/docusaurus.svg',
  translationRecruitingLink: 'https://crowdin.com/project/docusaurus',
  algolia: {
    apiKey: '0f9f28b9ab9efae89810921a351753b5',
    indexName: 'github',
  },
  gaTrackingId: 'UA-12345678-9',
  highlight: {
    theme: 'default',
  },
  markdownPlugins: [
    function foo(md) {
      md.renderer.rules.fence_custom.foo = function (
        tokens,
        idx,
        options,
        env,
        instance,
      ) {
        return '<div class="foo">bar</div>';
      };
    },
  ],
  scripts: [
    'https://docusaurus.io/slash.js',
    {
      src:
        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
      async: true,
    },
  ],
  stylesheets: [
    'https://docusaurus.io/style.css',
    {
      href: 'http://css.link',
      type: 'text/css',
    },
  ],
  facebookAppId: '1615782811974223',
  facebookComments: true,
  facebookPixelId: '352490515235776',
  twitter: 'true',
  twitterUsername: 'docusaurus',
  twitterImage: 'img/docusaurus.png',
  ogImage: 'img/docusaurus.png',
  cleanUrl: true,
  scrollToTop: true,
  scrollToTopOptions: {
    zIndex: 100,
  },
};

module.exports = siteConfig;
← Pages and Styles