Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
3a6d569
Bump dependencies to latest version
sim51 Aug 18, 2025
11aafd4
Using typescript
sim51 Aug 18, 2025
24d665b
Multi documentation websites
sim51 Aug 19, 2025
3c285cd
Fix for Windows
totetmatt Aug 20, 2025
9057f83
Drafts Gephi Lite documentation structure
jacomyal Aug 21, 2025
bf2b185
Improves styles
jacomyal Aug 21, 2025
49a761a
Updates footer links to fit website's
jacomyal Aug 25, 2025
d83ec01
[gephi-lite] Drafts Differences with Gephi page (wip)
jacomyal Aug 25, 2025
f79eb10
[gephi-lite] Drafts 'Differences with Gephi' doc page
jacomyal Aug 26, 2025
c284b45
[gephi-lite] Drafts 'Experimental features' doc page
jacomyal Aug 26, 2025
7377090
Fix build
sim51 Aug 27, 2025
353a107
[gephi-lite] Adding doc about github integration
sim51 Aug 27, 2025
421159c
[gephi-lite] deploying documentation
sim51 Aug 27, 2025
0bdf0ca
[gephi-lite] doc for permalinks
sim51 Aug 27, 2025
808e23f
new pages:
paulgirard Aug 28, 2025
124491e
[gephi-lite] Adds doc about the broadcast driver
jacomyal Sep 8, 2025
714652c
[gephi-lite] Fixes broken GitHub links in driver's doc
jacomyal Sep 9, 2025
0169703
[gephi-lite] driver code update
paulgirard Sep 12, 2025
3779465
Update desktop developer documentation, embed video
mbastian Oct 5, 2025
62a3d48
Add test dev versions
mbastian Oct 5, 2025
e7da7d0
Update Troubleshooting and cleanup
mbastian Oct 5, 2025
936058c
Export plugin page
mbastian Oct 5, 2025
28cdd4b
Filter plugin doc
mbastian Oct 5, 2025
b7e7f52
Generator plugin doc
mbastian Oct 5, 2025
6dbfdf3
Layout plugin doc
mbastian Oct 5, 2025
6e87679
Preview plugin doc
mbastian Oct 5, 2025
f9420fa
Stats plugin doc
mbastian Oct 5, 2025
caf85fb
Cleanup docs
mbastian Oct 5, 2025
5635c64
Cleanup and data lab plugin doc
mbastian Oct 6, 2025
aee6389
Plugin documentation index
mbastian Oct 6, 2025
bd2d577
Add desktop pages for gephi file formats
mbastian Oct 6, 2025
ac726dd
Page titles start with capital letter
mbastian Oct 7, 2025
5a862ab
CSV Import page
mbastian Oct 7, 2025
5d72c42
Update dynamic network page
mbastian Oct 7, 2025
f804cee
Add new index for Gephi desktop
mbastian Oct 7, 2025
ee06f15
Add issue template
mbastian Oct 7, 2025
811e91a
Merge branch 'master' into gephi-week-2025-multiple
mbastian Oct 7, 2025
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
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Documentation Issue
description: Suggest improvements or report problems with the Gephi documentation
title: "[Documentation]: "
labels: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help improve Gephi's documentation!

- type: dropdown
id: issue-type
attributes:
label: Issue Type
description: What type of issue are you submitting?
options:
- Documentation Suggestion
- Report a Problem
- Question about Documentation
- Other
validations:
required: true

- type: dropdown
id: documentation-area
attributes:
label: Documentation Area
description: Which part of the documentation does this concern?
options:
- Gephi Desktop - User Manual
- Gephi Desktop - Plugin Development
- Gephi Desktop - Developer Documentation
- Gephi Lite - User Manual
- Gephi Lite - Integration/Deployment
- Website/General
- Not sure
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Please provide a clear and detailed description of your suggestion or the problem you encountered.
placeholder: |
- What did you expect to find in the documentation?
- What is missing, unclear, or incorrect?
- What improvements would you suggest?
validations:
required: true

- type: textarea
id: location
attributes:
label: Location (if applicable)
description: If this concerns a specific page, please provide the URL or page title.
placeholder: "e.g., https://gephi.org/docs/... or 'Import CSV Data' page"
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, screenshots, or examples that might be helpful.
validations:
required: false

4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Dependencies
/node_modules
node_modules

# Production
/build
build

# Idea
.idea
Expand Down
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,46 @@
# Website
# Gephi documentations websites

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This repository is for the gephi projects documentation, with one site for Gephi (desktop) and an other one for Gephi-Lite.
In the futur, we can have others.

### Installation
Each of those sites are a docusaurus instance.

```
$ yarn
```
## How to use it

### Local Development
It's a javascript mono-repo project.

Before all, you need to install the project's dependencies
```
$ yarn start
$> npm install
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
There are 3 main commands in the project

### Build
### npm start

```
$ yarn build
$> npm start
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
It starts the project in dev mode, so you will have the hot reload feature.
Under the hood, it starts the docusaurus instance for geph & gephi-lite, as well as a vite server that serves the root index.html files and has a proxy for each docusaurus instance.

### Deployment
Open the url http://localhost:5173

Using SSH:
### npm run build

It builds the static website inside the `/build` directory.

```
$ USE_SSH=true yarn deploy
$> npm run build
```

Not using SSH:
### npm run preview

It runs a webserver that serves the `/build` directory. So it should be used after a `npm run build` to preview the build

```
$ GIT_USER=<Your GitHub username> yarn deploy
$> npm run preview
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Open the url http://localhost:5174
96 changes: 0 additions & 96 deletions docs/Developer_Documentation/Developer_Handbook.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/Developer_Documentation/index.md

This file was deleted.

81 changes: 0 additions & 81 deletions docs/Plugins/Add_a_module_panel.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/Plugins/Add_a_submenu.md

This file was deleted.

Loading