Skip to content

Commit cbfbb6c

Browse files
FylmTMFylmTM
committed
Add documentation structure
1 parent 8c2d103 commit cbfbb6c

23 files changed

+215
-16
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,5 @@ hs_err_pid*
9494
.Trash-*
9595

9696
idea-flex.skeleton
97-
/book-build
97+
/book-dev
9898
/_book

‎GLOSSARY.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Graph Database support
1+
# [Graph Database support](https://github.com/neueda/jetbrains-plugin-graph-database-support)
22
[![Build Status](https://travis-ci.org/neueda/jetbrains-plugin-graph-database-support.svg?branch=master)](https://travis-ci.org/neueda/jetbrains-plugin-graph-database-support)
33

44
Graph Database support plugin allows you to work with databases without leaving IDE.
@@ -8,7 +8,7 @@ Graph Database support plugin allows you to work with databases without leaving
88

99
Plugin is developed and supported by [Neueda R&D](http://neueda.lv/).
1010

11-
![plugin screenshot](_screenshots/plugin.png)
11+
![plugin screenshot](docs/screenshots/plugin.png)
1212

1313
## Installation
1414

‎SUMMARY.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎book.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2+
"root": "docs",
23
"structure": {
34
"readme": "README.md",
4-
"summary": "SUMMARY.md",
5-
"glossary": "GLOSSARY.md"
5+
"summary": "SUMMARY.md"
66
},
77
"title": "Jetbrains Plugin - Graph Database Support",
88
"description": "Graph Database support plugin allows you to work with databases without leaving IDE.",

‎docs/README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# [Graph Database support](https://github.com/neueda/jetbrains-plugin-graph-database-support)
2+
[![Build Status](https://travis-ci.org/neueda/jetbrains-plugin-graph-database-support.svg?branch=master)](https://travis-ci.org/neueda/jetbrains-plugin-graph-database-support)
3+
4+
Graph Database support plugin allows you to work with databases without leaving IDE.
5+
6+
- Bugs, questions, suggestions - [Issue tracker](https://github.com/neueda/jetbrains-plugin-graph-database-support/issues)
7+
- [Documentation](https://neueda.gitbooks.io/jetbrains-plugin-graph-database-support/content)
8+
9+
Plugin is developed and supported by [Neueda R&D](http://neueda.lv/).
10+
11+
![plugin screenshot](screenshots/plugin.png)
12+
13+
## Installation
14+
15+
Plugin is [available for download](https://plugins.jetbrains.com/plugin/8087) from Jetbrains repository.
16+
17+
1. Go to `Preferences` -> `Plugins` -> `Browser repositories...`
18+
2. Search for `Graph Database support`.
19+
3. Install plugin and restart IDE.
20+
21+
## Features
22+
23+
- Works in **any** Jetbrains IDE
24+
- Manage data sources
25+
- Write and execute queries
26+
- Explore query results in graph or table view
27+
- Supported databases:
28+
- Neo4j 3.0+ (Bolt)
29+
- [Cypher](https://github.com/opencypher/openCypher) query language:
30+
- Understands queries in `.cyp`, `.cypher` or `.cql` files
31+
- Syntax highlight and error reporting
32+
- Refactoring support for identifiers, labels, relationship types and properties
33+
- Autocompletion support for identifiers, labels, relationship types, properties, functions and stored procedures. Information gathered from existing queries and configured data sources
34+
- Provide documentation for functions and stored procedures
35+
- Auto-inject Cypher language for: [neo4j](https://github.com/neo4j/neo4j), [neo4j-ogm](https://github.com/neo4j/neo4j-ogm), [spring-data-neo4j](https://github.com/spring-projects/spring-data-neo4j), [neo4j-harness](https://github.com/neo4j/neo4j/tree/3.1/community/neo4j-harness), [py2neo](https://github.com/nigelsmall/py2neo)
36+
37+
## Supported Jetbrains products
38+
39+
* IntelliJ IDEA - **tested**.
40+
* RubyMine
41+
* WebStorm
42+
* PhpStorm
43+
* PyCharm
44+
* AppCode
45+
* Android Studio
46+
* Datagrip
47+
* CLion
48+
49+
Plugin is not tested (yet) with all existing Jetbrains products.
50+
However it should work without any issues.
51+
52+
## Development
53+
54+
Gradle is used as build system.
55+
56+
```shell
57+
# Build plugin distribution
58+
./gradlew buildPlugin
59+
60+
# Run idea in development mode
61+
./gradlew runIdea
62+
```
63+
64+
## Contacts
65+
66+
Please report any bugs or feature request by creating [new issue on Github](https://github.com/neueda/jetbrains-plugin-graph-database-support/issues/new).
67+
68+
You can easily reach us in case you have any questions or just want to chat about graph databases:
69+
70+
- Dmitry Vrublevsky ([email protected], [@FylmTM](https://twitter.com/FylmTM))
71+
- Andrew Naydyonock ([email protected], [@Cryptael](https://twitter.com/cryptael))
72+
- Neueda R&D ([@NeuedaDev](https://twitter.com/NeuedaDev))
73+

‎docs/SUMMARY.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Summary
2+
3+
* [Introduction](README.md)
4+
* [Data sources](data-sources/index.md)
5+
* [Neo4j - Bolt](data-sources/types/neo4j-bolt.md)
6+
* [Console](console/index.md)
7+
* [Log](console/log.md)
8+
* [Graph](console/graph/index.md)
9+
* [Canvas](console/graph/canvas.md)
10+
* [Table](console/table.md)
11+
* [Parameters](console/parameters.md)
12+
* [Cypher](cypher/index.md)
13+
* [Syntax](cypher/syntax.md)
14+
* [Autocompletion](cypher/autocompletion.md)
15+
* [Refactoring](cypher/refactoring.md)
16+
* [Inspections](cypher/inspections.md)
17+
* [Language injections](cypher/language-injections.md)

‎docs/console/graph/canvas.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Console - Graph - Canvas
2+
3+
TODO
4+
5+
<!--
6+
Node label logic
7+
Node color logic
8+
Loops
9+
Multiple relationships
10+
Interactions
11+
Move nodes
12+
Move canvas viewport
13+
Zoom in/out
14+
Select node
15+
Select relationship
16+
-->

‎docs/console/graph/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Console - Graph
2+
3+
### Canvas
4+
5+
Detailed [more information](canvas.md) about canvas features.
6+
7+
### Entity view
8+
9+
<!--
10+
Node information
11+
Relationship information
12+
-->

‎docs/console/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Console
2+
3+
TODO

‎docs/console/log.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Console - Log
2+
3+
### Query executions
4+
5+
TODO
6+
7+
<!--
8+
Information about query execution:
9+
- Query
10+
- Time
11+
- Error
12+
- Counters
13+
- ASCII representation of explain/profile
14+
-->

‎docs/console/parameters.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Console - Parameters
2+
3+
TODO

‎docs/console/table.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Console - Table
2+
3+
TODO

‎docs/cypher/autocompletion.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Cypher - Autocompletion
2+
3+
TODO

‎docs/cypher/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Cypher
2+
3+
TODO
4+
5+
<!--
6+
General information
7+
File type support
8+
-->

‎docs/cypher/inspections.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cypher - Inspection
2+
3+
### EXPLAIN warnings
4+
5+
TODO

‎docs/cypher/language-injections.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Cypher - Language injections
2+
3+
TODO
4+
5+
### Auto-injections
6+
7+
TODO
8+
9+
<!--
10+
Neo4j
11+
Neo4j-ogm
12+
spring-data-neo4j
13+
neo4j-harness
14+
py2neo
15+
-->

‎docs/cypher/refactoring.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Cypher - Refactoring
2+
3+
TODO

‎docs/cypher/syntax.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Cypher - Syntax
2+
3+
TODO

‎docs/data-sources/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Data sources
2+
3+
### Create
4+
5+
TODO
6+
7+
### Edit
8+
9+
TODO
10+
11+
### Remove
12+
13+
TODO
14+
15+
### Refresh
16+
17+
TODO
18+
19+
### Interactions
20+
21+
TODO
22+
23+
#### Editor
24+
25+
TODO

‎docs/data-sources/types/neo4j-bolt.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Data source - Neo4j Bolt
2+
3+
Supported Neo4j versions: 3.0+
4+
5+
### Configuration
6+
7+
TODO

‎docs/getting-started/index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎_screenshots/plugin.png renamed to ‎docs/screenshots/plugin.png

File renamed without changes.

0 commit comments

Comments
 (0)