neo4j-documentation / docs-ui Goto Github PK
View Code? Open in Web Editor NEWLicense: Mozilla Public License 2.0
License: Mozilla Public License 2.0
The frame and grid can be configured with Asciidoctor (read: https://mrhaki.blogspot.com/2014/11/awesome-asciidoctor-changing-grid-and.html)
Arguably, tables should not be used to layout elements but some documents are using them.
Here's the current rendering:
And here's the expected rendering:
For reference, here's the default Asciidoctor stylesheet: https://github.com/asciidoctor/asciidoctor/blob/cabde9c25fe040221ad71bb6aaf8754d2e5ec099/data/stylesheets/asciidoctor-default.css#L259-L269
csharp
-> C#
xml
-> XML
csv
-> CSV
js
-> JavaScript
javascript
-> JavaScript
If there's no explicit mapping, we should probably capitalize the first letter:
java
-> Java
scala
-> Scala
python
-> Python
groovy
-> Groovy
cypher
-> Cypher
I think conf
and properties
should remain in lowercase since they only refer to the file extension. Thoughts?
//cc @ElaineRosenberg
Hi,
I would like to customise and use this theme for our doc site. I would like to know if there are any restrictions for this.
Thank you!
The goal is to reduce the number of queries sent to Neo4j sandbox, aura and the GraphGists portal.
It should be possible to populate the cache from a query result generated at build time.
For instance, the GraphGists build could generate static files in the attachments directory that contain query results.
The source block component will then check if a file exists for a given couple page-query.
The source block component will use the cache when available. If not, it will switch to interactive mode and query the backend.
We could use a md5sum of the query as a unique key.
We can use https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage to save data.
Currently, the page-no-index
attribute does not apply to googlebot
or bingbot
:
docs-ui/src/partials/head-prelude.hbs
Lines 5 to 12 in 1f2107f
We should probably fix the condition:
The run buttons only have an effect if Neo4j Desktop is installed, as they go through the neo4j-desktop://
protocol. Not everybody has it, and as it currently stands it's impossible to know that that's a prerequisite. We should alert users when clicking, if the protocol is unavailable.
Right now readers have to click on the Read more
button explicitly - it would be nicer to be able to click anywhere in the code block area.
When switching version with the version dropdown, the browser's back button does not bring back to the previous version viewed, which in my expectations should.
Show a generic message instead of the enrollment form: "You cannot enroll in this course.".
This comes up in the browser console
Version 9 of Highlight.js has reached EOL and is no longer supported.
Please upgrade or ask whatever dependency you are using to upgrade.
highlightjs/highlight.js#2877
Here's a mockup:
"Database URL" should be renamed "Connection URL".
The default value of "Connection URL" field will be: bolt://localhost
.
If the query string dbms
is defined, we will use this value instead of the default value. For instance: https://neo4j.com/graphgists/northwind-recommendation-engine/?dbms=neo4j%2Bs://[email protected]
In this case, the value of the "Connection URL" field will be: neo4j+s://[email protected]
The connection URL will be used to update the link on the "Play as Browser Guide" button:
https://browser.neo4j.io/?cmd=play&arg=https://guides.neo4j.com/graph-examples/northwind-recommendation-engine/graph_guide&dbms={{connectionUrl}}
As you can see, the value of the field "Connection URL" is passed as a query string: &dbms={{connectionUrl}}
(where {{connectionUrl}}
is the connection URL filled out by the user).
Please note that we are now using https://browser.neo4j.io
instead of neo4j-desktop://graphapps/neo4j-browser
.
//cc @adam-cowley let me know what you think since you've worked on the original design.
They don't get the overlay with language/copy, nor the proper titling or collapsing.
- when a property list has multiple items, specify each property in a separate object within the list, and not as a single object containing them all.
+
.Good
[code, json]
----
"dates": [
{"born": "born"},
{"died": "died"}
]
----
Is your feature request related to a problem? Please describe.
I'm frustrated when I scroll down the docs content on the LHS, click on a section and the content section auto scrolls back to the top. This makes clicking through items in a particular section involve a lot of scrolling.
Describe the solution you'd like
Maintain scroll position of index after click
Describe alternatives you've considered
n/a
Additional context
Particularly relevant for APOC documentation which can have some very long sections
https://neo4j.com/docs/upgrade-migration-guide/current/version-4/migration/drivers/drivers-changes/
It has something to do with li
having data-depth
= 5.
For example,
span.label--discontinued {
background: var(--discontinued-color);
color: var(--discontinued-background-color);
}
var for background lacks background
in name and viceversa. Applies probably to all except for deprecated
.
See if we can replace custom code with built-in resolvePage
and/or resolvePageURL
UI helpers.
Currently, we are using the following prompts in the documentation:
neo4j-home> echo "foo"
$ echo "foo"
neo4j> call dbms.cluster.overview() yield addresses, role;
(on Neo4j shell)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.