mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
6003ea7e26
1. The test data is taken from tests, you can override attributes by adding keyword params to `doc` macro; 2. Additionally, you can add a section title using a `@moduledoc` in a controller and a controller action title using `@doc` on a controller function. (It will be added to all instances of its usage). 3. To make parameters nice a helper was added to build it using `DocHelper`, you can find an example in UserController. Overall, the code is messy, I'll need to revisit it, but was doing it in a rush so hope it's good enough for v0. Results you can see at https://firezone.docs.apiary.io/. To generate it locally run `DOC=1 mix test test/fz_http_web/controllers/json`. Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
179 lines
5.4 KiB
JavaScript
179 lines
5.4 KiB
JavaScript
// @ts-check
|
|
// Note: type annotations allow type checking and IDEs autocompletion
|
|
|
|
const lightCodeTheme = require('prism-react-renderer/themes/github');
|
|
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: 'Firezone',
|
|
tagline: 'Open-source VPN server and Linux firewall built on WireGuard®',
|
|
url: 'https://docs.firezone.dev',
|
|
baseUrl: '/',
|
|
onBrokenLinks: 'throw',
|
|
onBrokenMarkdownLinks: 'warn',
|
|
trailingSlash: true,
|
|
favicon: 'img/favicon.ico',
|
|
|
|
// GitHub pages deployment config.
|
|
// If you aren't using GitHub pages, you don't need these.
|
|
organizationName: 'firezone', // Usually your GitHub org/user name.
|
|
projectName: 'firezone', // Usually your repo name.
|
|
|
|
// Even if you don't use internalization, you can use this field to set useful
|
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
|
// to replace 'en' with 'zh-Hans'.
|
|
i18n: {
|
|
defaultLocale: 'en',
|
|
locales: ['en'],
|
|
},
|
|
|
|
// An array of scripts to load. The values can be either strings or plain
|
|
// objects of attribute-value maps. The <script> tags will be inserted in the
|
|
// HTML <head>. If you use a plain object, the only required attribute is src,
|
|
// and any other attributes are permitted (each one should have boolean/string
|
|
// values).
|
|
//
|
|
// Note that <script> added here are render-blocking, so you might want to
|
|
// add async: true/defer: true to the objects.
|
|
scripts: [
|
|
{
|
|
src: '/js/posthog.js',
|
|
async: true
|
|
}
|
|
],
|
|
|
|
plugins: [],
|
|
|
|
themes: [],
|
|
|
|
presets: [
|
|
[
|
|
'classic',
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
({
|
|
docs: {
|
|
routeBasePath: '/',
|
|
sidebarPath: require.resolve('./sidebars.js'),
|
|
editUrl: 'https://github.com/firezone/firezone/tree/master/docs',
|
|
docLayoutComponent: "@theme/DocPage"
|
|
},
|
|
theme: {
|
|
customCss: require.resolve('./src/css/custom.css'),
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
|
|
themeConfig:
|
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
|
({
|
|
navbar: {
|
|
title: 'Documentation',
|
|
logo: {
|
|
alt: 'Firezone Logo',
|
|
src: 'img/logo.svg',
|
|
},
|
|
items: [
|
|
{
|
|
href: 'https://discourse.firez.one/?utm_source=docs.firezone.dev',
|
|
label: 'Ask a Question',
|
|
position: 'right',
|
|
'aria-label': 'GitHub repository',
|
|
},
|
|
{
|
|
href: 'https://www.firezone.dev/contact/sales?utm_source=docs.firezone.dev',
|
|
label: 'Contact sales',
|
|
position: 'right',
|
|
'aria-label': 'Contact sales',
|
|
},
|
|
{
|
|
href: 'https://github.com/firezone/firezone',
|
|
className: 'header-github-link',
|
|
position: 'right',
|
|
'aria-label': 'GitHub repository',
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: 'light',
|
|
links: [
|
|
{
|
|
title: 'Company',
|
|
items: [
|
|
{
|
|
label: 'Homepage',
|
|
href: 'https://www.firezone.dev/?utm_source=docs.firezone.dev',
|
|
},
|
|
{
|
|
label: 'Pricing',
|
|
href: 'https://www.firezone.dev/pricing?utm_source=docs.firezone.dev',
|
|
},
|
|
{
|
|
label: 'About',
|
|
href: 'https://www.firezone.dev/about?utm_source=docs.firezone.dev',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Community',
|
|
items: [
|
|
{
|
|
label: 'Support Forums',
|
|
href: 'https://discourse.firez.one/?utm_source=docs.firezone.dev',
|
|
},
|
|
{
|
|
label: 'Slack',
|
|
href: 'https://www.firezone.dev/slack?utm_source=docs.firezone.dev',
|
|
},
|
|
{
|
|
label: 'Github',
|
|
href: 'https://github.com/firezone/firezone?utm_source=docs.firezone.dev',
|
|
},
|
|
{
|
|
label: 'Twitter',
|
|
href: 'https://twitter.com/firezonehq?utm_source=docs.firezone.dev',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © ${new Date().getFullYear()} Firezone, Inc.`,
|
|
},
|
|
prism: {
|
|
theme: lightCodeTheme,
|
|
darkTheme: darkCodeTheme,
|
|
additionalLanguages: ['ruby', 'elixir']
|
|
},
|
|
algolia: {
|
|
// The application ID provided by Algolia
|
|
appId: 'XXPZ9QVGFB',
|
|
|
|
start_urls: [
|
|
'https://docs.firezone.dev/'
|
|
],
|
|
|
|
sitemap_urls: [
|
|
'https://docs.firezone.dev/sitemap.xml'
|
|
],
|
|
|
|
// Public API key: it is safe to commit it
|
|
apiKey: '66664e8765e1645ea0b500acebb0b0c2',
|
|
|
|
indexName: 'firezone',
|
|
|
|
// Optional: see doc section below
|
|
// Requires more configuration and setup to work, so disabling. See
|
|
// https://discourse.algolia.com/t/algolia-searchbar-is-not-working-with-docusaurus-v2/14659/2
|
|
contextualSearch: true,
|
|
|
|
// Optional: path for search page that enabled by default (`false` to disable it)
|
|
searchPagePath: 'search',
|
|
|
|
//... other Algolia params
|
|
},
|
|
metadata: [{name: 'keywords', content: 'wireguard, vpn, firewall, remote access, network, documentation'}],
|
|
}),
|
|
};
|
|
|
|
module.exports = config;
|