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.

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

feat: Added Search Feature and Updated Theme #711

Merged
merged 8 commits into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 11 additions & 10 deletions doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,21 @@
</script>

3Dmol.js is an object-oriented, WebGL based JavaScript library for online molecular visualization - No Java required!
With 3Dmol.js, you can add beautifully rendered molecular visualizations to your web applications. Features include:
With 3Dmol.js, you can add beautifully rendered molecular visualizations to your web applications.

* support for pdb, sdf, mol2, xyz, and cube formats
* parallelized molecular surface computation
* sphere, stick, line, cross, cartoon, and surface styles
* atom property based selection and styling
* labels
* clickable interactivity with molecular data
* geometric shapes including spheres and arrows
Features include:

- Support for pdb, sdf, mol2, xyz, and cube formats
- Parallelized molecular surface computation
- Sphere, stick, line, cross, cartoon, and surface styles
- Atom property based selection and styling
- Labels
- Clickable interactivity with molecular data
- Geometric shapes including spheres and arrows

## Getting Started

Molecular data can be shared and visualized without writing any HTML
using only a declarative URL specification and our hosted viewer (see {@tutorial url}).
Molecular data can be shared and visualized without writing any HTML using only a declarative URL specification and our hosted viewer (see {@tutorial url}).

Viewers can be quickly embedded in any HTML document using just two lines of source code (see {@tutorial embeddable}).

Expand Down
75 changes: 51 additions & 24 deletions jsdoc.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,71 @@
"tags": {
"allowUnknownTags": true
},
"plugins": ["plugins/markdown",
"../../node_modules/better-docs/typescript",
"../../node_modules/better-docs/category"],
"plugins": [
"plugins/markdown",
"../../node_modules/better-docs/typescript",
"../../node_modules/better-docs/category"
],
"recurseDepth": 10,
"source": {
"includePattern": "\\.(jsx|js|ts|tsx)$"
},
"templates": {
"search": true,
"cleverLinks": true,
"monospaceLinks": false,
"footer": "",
"copyright":"3Dmol.js © 2019-2023",
"linenums" : true,
"collapseSymbols" : false,
"inverseNav" : true,
"highlightTutorialCode" : true,
"better-docs": {
"name": "<a href=\"http://3dmol.org\"><b>3Dmol</b>.js</a><script async src=\"https://cse.google.com/cse.js?cx=5192956647d8a4a4b\"></script><div class=\"gcse-search\"></div>",
adithyaakrishna marked this conversation as resolved.
Show resolved Hide resolved
"title": "3Dmol.js Documentation",
"css": "../tutorials/style.css",
"navLinks": [
{
"label": "Github",
"href": "https://github.com/3dmol/3Dmol.js"
}
]
}
"highlightTutorialCode" : true
},
"markdown" : {
"parser" : "gfm",
"hardwrap" : true
"hardwrap": true,
"idInHeadings": true
},
"opts":{
"recurse": true,
"encoding": "utf8",
"template": "./node_modules/better-docs",
"destination": "doc",
"tutorials": "tutorials",
"search": true
},
"tutorials": "tutorials/"
"destination": "doc/",
"recurse": true,
"verbose": true,
"template": "./node_modules/clean-jsdoc-theme",
"copyright": "3Dmol.js © 2019-2023",
"theme_opts": {
"default_theme": "light",
"includeFilesListInHomepage": true,
"homepageTitle": "3Dmol.js",
"displayModuleHeader": true,
"footer":"3Dmol.js © 2019-2023 | <a href='https://pitt.edu/' target='_blank'>University of Pittsburgh</a> | <a href='https://github.com/3dmol/3Dmol.js/blob/master/LICENSE' target='_blank'>License</a>",
"title": "3Dmol.js",
"create_style": "article ul li { list-style: disc}",
"menu": [
{
"title": " Documentation",
"link": "https://3dmol.org/doc/index.html"
},
{
"title": "Tutorials",
"link": "tutorial-home.html"
},
{
"title": "GitHub",
"link": "https://github.com/3dmol/3Dmol.js",
"target": "_blank"
}
],
"meta": [
{
"name": "Author",
"content": "David Koes & 3Dmoljs Contributors"
},
{
"name": "Description",
"content": "A modern, object-oriented JavaScript library for visualizing molecular data"
}
]
},
"tutorials": "tutorials/"
}
}
Loading