Skip to content

thedevdrawer/react-markdown-documentation-portal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

React Markdown Documentation Portal

Build your own lightweight alternative to Docusaurus using React and Markdown. With this project, you can build the server once and modify or add to your docs in the public folder...so no need to rebuild.

Manually Install Dependencies

Run the following in your terminal:

npm install @emotion/react@^11.14.0 @emotion/styled@^11.14.1 @mui/icons-material@^6.5.0 @mui/material@^6.5.0 @testing-library/dom@^10.4.1 @testing-library/jest-dom@^6.6.4 @testing-library/react@^16.3.0 @testing-library/user-event@^13.5.0 cra-template@^1.2.0 react-dom@^19.1.1 react-markdown@^9.1.0 react-router-dom@^7.8.0 react-scripts@^5.0.1 rehype-raw@^7.0.0 remark-gfm@^4.0.1 web-vitals@^2.1.4 @babel/plugin-transform-private-property-in-object@^7.27.1 sass@^1.90.0

Install Dependencies from Repo

In your parent folder run npm i to install the dependencies.

Styles

You can either use my styles or modify them as needed for your project. If you use my styles, it should work out immediately with the project layout.

Colors: https://github.com/thedevdrawer/react-markdown-documentation-portal/blob/main/src/sass/colors.scss Layout: https://github.com/thedevdrawer/react-markdown-documentation-portal/blob/main/src/sass/layout.scss

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

About

Build your own lightweight alternative to Docusaurus.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •