11// @ts -check
22// `@type` JSDoc annotations allow editor autocompletion and type checking
3- // (when paired with `@ts-check`).
4- // There are various equivalent ways to declare your Docusaurus config.
5- // See: https://docusaurus.io/docs/api/docusaurus-config
63
74import { themes as prismThemes } from 'prism-react-renderer' ;
85
96/** @type {import('@docusaurus/types').Config } */
107const config = {
118 title : 'BinSync' ,
129 tagline : 'A framework for understanding binaries across tools and analyses' ,
10+
11+ // ✅ Favicon must be top-level; path is relative to /static
1312 favicon : 'img/favicon.ico' ,
1413
15- // Set the production url of your site here
14+ // Site URL settings
1615 url : 'https://docs.binsync.net' ,
17- // Set the /<baseUrl>/ pathname under which your site is served
18- // For GitHub pages deployment, it is often '/<projectName>/'
1916 baseUrl : '/' ,
2017
21- // GitHub pages deployment config.
22- // If you aren't using GitHub pages, you don't need these.
23- organizationName : 'facebook' , // Usually your GitHub org/user name.
24- projectName : 'docusaurus' , // Usually your repo name.
25-
2618 onBrokenLinks : 'throw' ,
2719 onBrokenMarkdownLinks : 'warn' ,
2820
29- // Even if you don't use internationalization, you can use this field to set
30- // useful metadata like html lang. For example, if your site is Chinese, you
31- // may want to replace "en" with "zh-Hans".
3221 i18n : {
3322 defaultLocale : 'en' ,
3423 locales : [ 'en' ] ,
@@ -41,23 +30,13 @@ const config = {
4130 ( {
4231 docs : {
4332 sidebarPath : './sidebars.js' ,
44- // Please change this to your repo.
45- // Remove this to remove the "edit this page" links.
46- editUrl :
47- 'https://github.com/binsync/docs.binsync.net' ,
33+ editUrl : 'https://github.com/binsync/docs.binsync.net' ,
4834 routeBasePath : '/' ,
4935 } ,
5036 blog : {
5137 showReadingTime : true ,
52- feedOptions : {
53- type : [ 'rss' , 'atom' ] ,
54- xslt : true ,
55- } ,
56- // Please change this to your repo.
57- // Remove this to remove the "edit this page" links.
58- editUrl :
59- 'https://github.com/binsync/docs.binsync.net' ,
60- // Useful options to enforce blogging best practices
38+ feedOptions : { type : [ 'rss' , 'atom' ] , xslt : true } ,
39+ editUrl : 'https://github.com/binsync/docs.binsync.net' ,
6140 onInlineTags : 'warn' ,
6241 onInlineAuthors : 'warn' ,
6342 onUntruncatedBlogPosts : 'warn' ,
@@ -72,70 +51,47 @@ const config = {
7251 themeConfig :
7352 /** @type {import('@docusaurus/preset-classic').ThemeConfig } */
7453 ( {
75- // Replace with your project's social card
54+ // OpenGraph / social card image is fine here
7655 image : 'img/favicon.ico' ,
56+
7757 navbar : {
7858 title : 'BinSync' ,
7959 logo : {
8060 alt : 'BinSync' ,
8161 src : 'img/logo.svg' ,
8262 } ,
8363 items : [
84- {
85- type : 'docSidebar' ,
86- sidebarId : 'tutorialSidebar' ,
87- position : 'left' ,
88- label : 'Tutorial' ,
89- } ,
90- { to : '/blog' , label : 'Blog' , position : 'left' } ,
91- {
92- href : 'https://github.com/binsync/binsync' ,
93- label : 'GitHub' ,
94- position : 'right' ,
95- } ,
64+ { type : 'docSidebar' , sidebarId : 'tutorialSidebar' , position : 'left' , label : 'Tutorial' } ,
65+ { to : '/blog' , label : 'Blog' , position : 'left' } ,
66+ { href : 'https://github.com/binsync/binsync' , label : 'GitHub' , position : 'right' } ,
9667 ] ,
9768 } ,
69+
9870 footer : {
9971 style : 'dark' ,
10072 links : [
10173 {
10274 title : 'Docs' ,
103- items : [
104- {
105- label : 'Tutorial' ,
106- to : '/intro' ,
107- } ,
108- ] ,
75+ items : [ { label : 'Tutorial' , to : '/intro' } ] ,
10976 } ,
11077 {
11178 title : 'Community' ,
11279 items : [
113- {
114- label : 'Discord' ,
115- href : 'https://discord.gg/seujzRAwdZ' ,
116- } ,
117- {
118- label : 'Twitter' ,
119- href : 'https://twitter.com/mahal0z' ,
120- } ,
80+ { label : 'Discord' , href : 'https://discord.gg/seujzRAwdZ' } ,
81+ { label : 'Twitter' , href : 'https://twitter.com/mahal0z' } ,
12182 ] ,
12283 } ,
12384 {
12485 title : 'More' ,
12586 items : [
126- {
127- label : 'Blog' ,
128- to : '/blog' ,
129- } ,
130- {
131- label : 'GitHub' ,
132- href : 'https://github.com/binsync' ,
133- } ,
87+ { label : 'Blog' , to : '/blog' } ,
88+ { label : 'GitHub' , href : 'https://github.com/binsync' } ,
13489 ] ,
13590 } ,
13691 ] ,
13792 copyright : `Copyright © ${ new Date ( ) . getFullYear ( ) } My Project, Inc. Built with Docusaurus.` ,
13893 } ,
94+
13995 prism : {
14096 theme : prismThemes . github ,
14197 darkTheme : prismThemes . dracula ,
0 commit comments