Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create docusaurus.config.js #320

Closed
wants to merge 1 commit into from
Closed

Create docusaurus.config.js #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
module.exports = {
title: 'VTEX SDK',

Check notice on line 2 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L2 

Strings must use doublequote.
tagline: 'Documentation for VTEX SDK',

Check notice on line 3 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L3 

Strings must use doublequote.
url: 'https://guibranco.github.io',

Check notice on line 4 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L4 

Strings must use doublequote.
baseUrl: '/VTEX-SDK-dotnet/',

Check notice on line 5 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L5 

Strings must use doublequote.
onBrokenLinks: 'throw',

Check notice on line 6 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L6 

Strings must use doublequote.
onBrokenMarkdownLinks: 'warn',

Check notice on line 7 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L7 

Strings must use doublequote.
favicon: 'img/favicon.ico',

Check notice on line 8 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L8 

Strings must use doublequote.
organizationName: 'guibranco',

Check notice on line 9 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L9 

Strings must use doublequote.
projectName: 'VTEX-SDK-dotnet',

Check notice on line 10 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L10 

Strings must use doublequote.
Comment on lines +8 to +10
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Favicon File Missing

The favicon.ico file does not exist in the repository. Please add the favicon file at img/favicon.ico or update the path in docusaurus.config.js to the correct location.

🔗 Analysis chain

LGTM: Favicon and organization settings are correct.

The organization and project names correctly match the GitHub repository information.

Please verify that the favicon file exists at the specified path. Run the following script to check:

Action Required: Correct the Favicon Verification Script

The previous script encountered errors by checking the wrong file (logo.svg instead of favicon.ico) and had a syntax issue. Please run the corrected script below to ensure the favicon file exists at the specified path.

Action Required: Favicon File Not Found at Specified Path

The favicon file is missing at static/img/favicon.ico. Please verify its location or update the path in docusaurus.config.js accordingly.

To locate the favicon file, run the following script:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the favicon file.

# Test: Check if the favicon file exists
if [ -f "static/img/favicon.ico" ]; then
    echo "Favicon file exists."
else
    echo "Favicon file not found at static/img/favicon.ico"
    echo "Please ensure the file is present or update the path in the configuration."
fi

Length of output: 381

Script:

#!/bin/bash
# Description: Verify the existence of the favicon file.

# Test: Check if the favicon file exists
if [ -f "static/img/favicon.ico" ]; then
    echo "Favicon file exists."
else
    echo "Favicon file not found at static/img/favicon.ico"
    echo "Please ensure the file is present or update the path in the configuration."
fi

Length of output: 301

Script:

#!/bin/bash
# Description: Search for favicon.ico in the codebase.

fd 'favicon\.ico$' .

Length of output: 22

themeConfig: {
navbar: {
title: 'VTEX SDK',
logo: {
alt: 'VTEX Logo',

Check notice on line 15 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L15 

Strings must use doublequote.
src: 'img/logo.svg',

Check notice on line 16 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L16 

Strings must use doublequote.
},
items: [
{to: 'docs/', label: 'Docs', position: 'left'},

Check notice on line 19 in docs/docusaurus.config.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/docusaurus.config.js#L19 

Strings must use doublequote.
],
},
},
};
Loading