-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdatabase.json
More file actions
1 lines (1 loc) · 12.6 KB
/
Copy pathdatabase.json
File metadata and controls
1 lines (1 loc) · 12.6 KB
1
{"filename":"/home/computer/Github/docs4all/database.json","collections":[{"name":"documents","data":[{"path":"/Roadmap.md","id":0,"type":"child","text":"\n\n\n# Roadmap\n\n- [ ] add unit test and coverage\n- [ ] breadcrumb\n- [ ] use npm for css and js\n- [ ] ssr for title\n- [ ] standardize the meta for files and folders (key : value syntax) \n- [ ] improve seo : permalink, fragments, etc\n- [ ] improve search result css\n- [ ] highlight search results with [Highlight.js](http://highlightjs.org)\n- [ ] docker\n- [ ] minify and optimize javascript files\n- [ ] add google login\n- [ ] more documentation\n- [ ] add video tutorials\n- [ ] publish to npm repository: https://www.npmjs.com/package/repository","name":"Roadmap.md","order":6,"title":"Roadmap","meta":{"revision":0,"created":1713739508912,"version":0},"$loki":1},{"path":"/contributing.md","id":1,"type":"child","text":"\n\n\nWant to report a bug, request a feature, contribute or translate docs4all? At the moment most things can be\ncontributed via the main [docs4all GitHub repository](https://github.com/docs4all/docs4all).\n\n* [Submit a bug report](https://github.com/docs4all/docs4all/issues?labels=bug)\n* [Submit a feature request](https://github.com/docs4all/docs4all/issues?labels=enhancement)\n* [Submit a pull request](https://github.com/docs4all/docs4all/pulls)\n","name":"contributing.md","order":3,"title":"Contributing","meta":{"revision":0,"created":1713739508912,"version":0},"$loki":2},{"path":"/markdown sample.md","id":2,"type":"child","text":"\n\n\n# Markdown syntax guide\n\nFrom https://markdownlivepreview.com/\n\n## Headers\n\n# This is a Heading h1\n## This is a Heading h2\n###### This is a Heading h6\n\n## Emphasis\n\n*This text will be italic* \n_This will also be italic_\n\n**This text will be bold** \n__This will also be bold__\n\n_You **can** combine them_\n\n## Lists\n\n### Unordered\n\n* Item 1\n* Item 2\n* Item 2a\n* Item 2b\n\n### Ordered\n\n1. Item 1\n1. Item 2\n1. Item 3\n 1. Item 3a\n 1. Item 3b\n\n## Images\n\n\n\n## Links\n\nYou may be using [Markdown Live Preview](https://markdownlivepreview.com/).\n\n## Blockquotes\n\n> Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by John Gruber with Aaron Swartz.\n>\n>> Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.\n\n## Tables\n\n| Left columns | Right columns |\n| ------------- |:-------------:|\n| left foo | right foo |\n| left bar | right bar |\n| left baz | right baz |\n\n## Blocks of code\n\n```\nlet message = 'Hello world';\nalert(message);\n```\n\n## Inline code\n\nThis web site is using `markedjs/marked`.","name":"markdown sample.md","order":1,"title":"Markdown Sample","meta":{"revision":0,"created":1713739508913,"version":0},"$loki":3},{"path":"/root.md","id":3,"type":"child","text":"\nDocs4all is a Knowledgebase platform for [Node.js](http://nodejs.org) that uses static\n[Markdown](http://daringfireball.net/projects/markdown) files to power the knowledgebase.\n\nOfficial repository: [https://github.com/docs4all/docs4all](https://github.com/docs4all/docs4all)\n\nDocs4all can be called a \"static site generator\" of sorts as it doesn't require a database. All\nof your content is stored in the `markdown` folder in Markdown (`.md`) files and the entire\nknowledgebase structure and content is generated by docs4all. This is good because it's:\n\n* **Simple:** You can create and manage an entire knowledge base using your favorite text editor\n* **Flat:** docs4all is a \"flat file\", meaning no database, no MySQL queries, nothing\n* **Fast:** docs4all is seriously lightweight and doesn't use a database, making it super fast\n\nDocs4all features:\n\n* Responsive default template (powered by [bootstrap-simple-admin-template](https://github.com/alexis-luna/bootstrap-simple-admin-template))\n* Full-text search powered by [LokiJS](https://github.com/techfort/LokiJS)\n\nTechnologies:\n\n* nodejs\n* [markdown-it](https://www.npmjs.com/package/markdown-it) for easy templating\n* [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown)\n* [nodeboot-web-security-starter](https://github.com/jrichardsz-software-architect-tools/nodeboot-web-security-starter)\n\nReady to use template:\n\n[https://github.com/docs4all/docs4all-demo](https://github.com/docs4all/docs4all-demo)\n\n---","name":"root.md","meta":{"revision":0,"created":1713739508913,"version":0},"$loki":4},{"path":"/settings","id":4,"name":"settings","type":"node","order":5,"title":"Settings","meta":{"revision":0,"created":1713739508913,"version":0},"$loki":5},{"path":"/settings/authentication.md","id":5,"parent":4,"type":"child","text":"\n\n## Authentication\n\nAuthentication is only available if you use nodejs to start the wiki. Published site are just index.html, css, js, etc without any kind of authentication.\n\nTo enable basic Authentication in docs4all is very simple.\n\n### Simple Login\n\nJust export these variables before the start\n\n```\nexport LOGIN_TYPE=simple\nexport USER_jane=changeme\nexport USER_kurt=secret\n```\n\nMore details here: https://github.com/jrichardsz-software-architect-tools/nodeboot-web-security-starter#how-it-works\n\n### Microsoft Login\n\nJust export these variables before the start\n\n```\nexport LOGIN_TYPE=microsoft\nexport BASE_URL=www.acmedocs.com\nexport LOGIN_OAUTH2_CLIENT_ID=*****\nexport LOGIN_OAUTH2_CLIENT_SECRET=*****\nexport ALLOWED_USERS=\"jane_doe@microsoft.com,kurt_weller@hotmail.com\"\n```\n\nMore details here: https://github.com/jrichardsz-software-architect-tools/mkdocs-mod-template/wiki/Add-microsoft-login","name":"authentication.md","order":1,"title":"Authentication","meta":{"revision":0,"created":1713739508913,"version":0},"$loki":6},{"path":"/settings/how to update.md","id":6,"parent":4,"type":"child","text":"\n\n## How to update\n\nTo use the latest version of docs4all, just perform the npm install of the latest repository:\n\n```\nnpm install https://github.com/docs4all/docs4all.git\n```","name":"how to update.md","order":5,"title":"How to update","meta":{"revision":0,"created":1713739508914,"version":0},"$loki":7},{"path":"/settings/page-meta.md","id":7,"parent":4,"type":"child","text":"\n\n## Metadata\n\nEach page can contain optional meta data about the page. This is useful when you need the page to have a different Title than the file name, custom sort, etc \n\n**For files**, add this comment at the beginning of markdown file:\n\n```\n<!--\n{\n \"order\":1,\n \"title\": \"Markdown Sample\"\n}\n-->\n```\n\n**For folders**, add a file called **meta.json** inside of it with this content:\n\n```\n{\n \"order\":2,\n \"title\": \"Folder\"\n}\n```\n\n## title \n\nThis variable will override the title based on the file name or folder name.\n\n\n## sort\n\nThis variable will affect the sorting of the pages inside the category. By default pages and folders are sorted alphabetically.","name":"page-meta.md","order":2,"title":"Metadata","meta":{"revision":0,"created":1713739508914,"version":0},"$loki":8},{"path":"/settings/ui customizations.md","id":8,"parent":4,"type":"child","text":"\n\n\n## UI Customizations\n\nYou can customize everything in docs4all. \n\n### Html Theme\n\nJust copy the **theme** folder from the [official repository](https://github.com/docs4all/docs4all) to the workspace root and then if you know html , css & javascript do whatever you want.\n\n## Html Title\n\n` <title>{{site_name}}</title>`\n\nTo customize, create a **settings.yaml** file at the workspace root with the following value\n\n```yaml\nsite_name: Docs4all\n```\n\n### Logo\n\n\n\nTo override the logo, choose one of the following options.\n\n### Text logo\n\nTo customize, create a **settings.yaml** file at the workspace root with the following value\n\n```yaml\nlogo: Foo Bar Baz\n```\n\nResult will be:\n\n\n\n\n### Image file \n\nTo customize, create a **settings.yaml** file at the workspace root with the following value\n\n```yaml\nlogo: ./nodejs-logo.png\n```\n\n- It is mandatory to start with `./`\n- In this example **nodejs-logo.png** should be at the root of workspace\n\nResult will be:\n\n\n\n### Image url\n\nTo customize, create a **settings.yaml** file at the workspace root with the following value\n\n```yaml\nlogo: https://i.ibb.co/zm3Xs2R/docs4all-logo-image.png\n```\n\nTo get a better dimensions, use our [template](https://github.com/docs4all/docs4all/wiki/Logo-Image-Template) or an image of 210 × 42 px","name":"ui customizations.md","order":3,"title":"UI Customizations","meta":{"revision":0,"created":1713739508914,"version":0},"$loki":9},{"path":"/settings/variables.md","id":9,"parent":4,"type":"child","text":"\n\n\n## Variables\n\nTo use variables in your markdown files, create a **settings.yaml** file at the workspace root with the following values\n\n```yaml\nglobal_csr_variables:\n best_language: Java\n```\n\nThen in your markdown files, use this placeholder  like this:\n\n\n\nThe render engine will replace the placeholder with your declared variable at runtime (CSR), not at server side (SSR). Result will be:\n\n`The best language is {{best_language}}`","name":"variables.md","order":4,"title":"Variables","meta":{"revision":0,"created":1713739508914,"version":0},"$loki":10},{"path":"/showcase.md","id":10,"type":"child","text":"\n\nUsing docs4all in the wild? We'd love to see it. \n\nShare us [here](https://github.com/docs4all/docs4all/issues) the name, screenshot and url of your site\n","name":"showcase.md","order":2,"title":"Showcase","meta":{"revision":0,"created":1713739508915,"version":0},"$loki":11},{"path":"/startup","id":11,"name":"startup","type":"node","order":4,"title":"Startup","meta":{"revision":0,"created":1713739508915,"version":0},"$loki":12},{"path":"/startup/installing.md","id":12,"parent":11,"type":"child","text":"\n\n\nMake sure you have met the [minimum requirements](./install/requirements) then install\ndocs4all:\n\n**Note:** It is recommended to create a new Git repository to store your documentation files.\n\n## Demo (with nodejs)\n\n- clone the template: https://github.com/docs4all/docs4all-demo\n- add your own files in **markdown** folder\n- for developers\n\n```\nnpm install\nnpm run dev\n```\n\n- for production with node\n\n```\nnpm install\nnpm run start\n```\n\n## Demo (static web)\n\n- clone the template: https://github.com/docs4all/docs4all-demo\n- add your own files in markdown folder\n- execute\n\n```\nnpm install\nnpm run build\nnpm run publish\n```\n\n- this will create a **site** folder with the static files ready to deploy on any http server\n","name":"installing.md","order":2,"title":"Startup","meta":{"revision":0,"created":1713739508915,"version":0},"$loki":13},{"path":"/startup/requirements.md","id":13,"parent":11,"type":"child","text":"\n\n\nTo run docs4all as server or build the static website, you need to have:\n\n* [Node.js](http://nodejs.org) **v16** (or later)\n","name":"requirements.md","order":1,"title":"Requirements","meta":{"revision":0,"created":1713739508915,"version":0},"$loki":14}],"idIndex":null,"binaryIndices":{},"constraints":null,"uniqueNames":[],"transforms":{},"objType":"documents","dirty":false,"cachedIndex":null,"cachedBinaryIndex":null,"cachedData":null,"adaptiveBinaryIndices":true,"transactional":false,"cloneObjects":false,"cloneMethod":"parse-stringify","asyncListeners":false,"disableMeta":false,"disableChangesApi":true,"disableDeltaChangesApi":true,"autoupdate":false,"serializableIndices":true,"disableFreeze":true,"ttl":null,"maxId":14,"DynamicViews":[],"events":{"insert":[],"update":[],"pre-insert":[],"pre-update":[],"close":[],"flushbuffer":[],"error":[],"delete":[null],"warning":[null]},"changes":[],"dirtyIds":[]}],"databaseVersion":1.5,"engineVersion":1.5,"autosave":false,"autosaveInterval":5000,"autosaveHandle":null,"throttledSaves":true,"options":{"autoload":true,"serializationMethod":"normal","destructureDelimiter":"$<\n","recursiveWait":true,"recursiveWaitLimit":false,"recursiveWaitLimitDuration":2000,"started":1713739508917},"persistenceMethod":"fs","persistenceAdapter":null,"verbose":false,"events":{"init":[null],"loaded":[],"flushChanges":[],"close":[],"changes":[],"warning":[]},"ENV":"NODEJS"}