File tree Expand file tree Collapse file tree 4 files changed +18
-9
lines changed Expand file tree Collapse file tree 4 files changed +18
-9
lines changed Original file line number Diff line number Diff line change @@ -125,6 +125,12 @@ module.exports = {
125125 - jwtSecret: SECRET KEY
126126- Click "Deploy branch" button
127127
128- ## Generate [ JSDoc] ( https://jsdoc.app/ ) documentation
128+ ## [ JSDoc] ( https://jsdoc.app/ ) documentation
129+
130+ ### Generate
129131
130132run ` npm run doc `
133+
134+ ### View
135+
136+ [ react-notes-docs] ( http://react-notes-docs.std-1033.ist.mospolytech.ru )
Original file line number Diff line number Diff line change @@ -31,8 +31,12 @@ function AboutPage() {
3131 < div className = "p-1 py-3 my-3" >
3232 < section className = "container" >
3333 < h5 > О проекте</ h5 >
34- < p > Веб-приложение "Заметки" на стеке MERN</ p >
35- < a href = "https://github.com/maxchistt/react-notes" target = "blank" > GitHub</ a >
34+ < p > Веб-приложение "Заметки" на стеке MERN с авторизацией, синхронизацией и удобным интерфейсом редактирования</ p >
35+ < p >
36+ < a href = "http://react-notes-docs.std-1033.ist.mospolytech.ru" target = "blank" > Документация</ a >
37+ < br />
38+ < a href = "https://github.com/maxchistt/react-notes" target = "blank" > GitHub</ a >
39+ </ p >
3640 </ section >
3741 </ div >
3842 </ div >
Original file line number Diff line number Diff line change 2121 " client/src/NoteComponents/palette"
2222 ],
2323 "includePattern" : " .js$" ,
24- "excludePattern" : " (docs|node_modules/|client/node_modules/|client/build/)"
24+ "excludePattern" : " (docs|node_modules/|server/node_modules/| client/node_modules/|client/build/)"
2525 },
2626 "plugins" : [
2727 " plugins/markdown"
3232 },
3333 "opts" : {
3434 "recurse" : false ,
35- "destination" : " ./ docs/" ,
36- "readme" : " ./readme .md"
35+ "destination" : " ../react-notes- docs/" ,
36+ "readme" : " ./README .md"
3737 }
3838}
Original file line number Diff line number Diff line change 2929 "mongo-ubuntu:full-setup" : " npm run mongo-ubuntu:update && npm run mongo-ubuntu:prepare && npm run mongo-ubuntu:setup" ,
3030 "mongo-ubuntu:start" : " (cd mongo/Ubuntu && ./mongo_ubuntu_install.sh)" ,
3131 "mongo-windows:start" : " (cd mongo/Windows && start mongo_win_install.bat)" ,
32- "doc:generate" : " jsdoc -c jsdoc.json" ,
33- "doc:open" : " start docs/index.html" ,
34- "doc" : " npm run doc:generate && npm run doc:open"
32+ "doc" : " jsdoc -c jsdoc.json" ,
33+ "doc:open" : " start ../react-notes-docs/index.html"
3534 },
3635 "repository" : {
3736 "type" : " git" ,
You can’t perform that action at this time.
0 commit comments