rise-docs/docusaurus.config.js at main · The-Low-Code-Foundation/rise-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightTheme = require('prism-react-renderer').themes.github;
const darkTheme = require('prism-react-renderer').themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Rise Documentation',
  tagline: 'AI-powered visual low-code builder for React',
  favicon: 'img/favicon.ico',

  // Production URL
  url: 'https://rise-docs.example.com',
  baseUrl: '/',

  // GitHub pages deployment config
  organizationName: 'richardosborne14',
  projectName: 'rise',

  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',

  // Internationalization (if needed in future)
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Edit URL for GitHub
          editUrl:
            'https://github.com/richardosborne14/rise/tree/main/docs/',
        },
        blog: false, // Disable blog for now
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // Social card for sharing
      image: 'img/rise-social-card.jpg',

      navbar: {
        title: 'Rise',
        logo: {
          alt: 'Rise Logo',
          src: 'img/logo.svg',
        },
        items: [
          {
            type: 'doc',
            docId: 'intro',
            position: 'left',
            label: 'Docs',
          },
          {
            type: 'doc',
            docId: 'getting-started',
            position: 'left',
            label: 'Get Started',
          },
          {
            href: 'https://github.com/richardosborne14/rise',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },

      footer: {
        style: 'dark',
        links: [
          {
            title: 'Documentation',
            items: [
              {
                label: 'Introduction',
                to: '/docs/intro',
              },
              {
                label: 'Getting Started',
                to: '/docs/getting-started',
              },
              {
                label: 'Core Concepts',
                to: '/docs/concepts/overview',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'GitHub',
                href: 'https://github.com/richardosborne14/rise',
              },
              {
                label: 'Discussions',
                href: 'https://github.com/richardosborne14/rise/discussions',
              },
              {
                label: 'Issues',
                href: 'https://github.com/richardosborne14/rise/issues',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'Architecture',
                to: '/docs/architecture/overview',
              },
              {
                label: 'Contributing',
                to: '/docs/contributing',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Rise. Built with Docusaurus.`,
      },

      prism: {
        theme: lightTheme,
        darkTheme: darkTheme,
        additionalLanguages: ['bash', 'typescript', 'jsx', 'tsx', 'json'],
      },

      // Algolia search (configure when ready)
      // algolia: {
      //   appId: 'YOUR_APP_ID',
      //   apiKey: 'YOUR_SEARCH_API_KEY',
      //   indexName: 'rise',
      // },
    }),
};

module.exports = config;