Skip to content

Commit

Permalink
[Minor][Doc] Add GraphAr logo to README (#197)
Browse files Browse the repository at this point in the history
Signed-off-by: acezen <[email protected]>
  • Loading branch information
acezen authored Jul 10, 2023
1 parent c06e81f commit 137f121
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ jobs:
popd
- name: Preview using surge
if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'alibaba/GraphAr' && github.repository == 'alibaba/GraphAr' }}
if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'alibaba/GraphAr' }}
run: |
npm install -g surge
surge ./docs/_build/html \
Expand Down
14 changes: 9 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
GraphAr
========
.. raw:: html

|GraphAr CI| |Docs CI| |GraphAr Docs| |Good First Issue|
<h1 align="center" style="clear: both;">
<img src="https://alibaba.github.io/GraphAr/_images/graphar-logo.svg" width="350" alt="GraphAr">
</h1>
<p align="center">
An open source, standard data file format for graph data storage and retrieval
</p>

Welcome to GraphAr (short for "Graph Archive"), an open source, standardized file format for graph data storage and retrieval.
|GraphAr CI| |Docs CI| |GraphAr Docs| |Good First Issue|

📢 Join our `Weekly Community Meeting`_ to learn more about GraphAr and get involved!

Expand All @@ -23,7 +27,7 @@ Graph processing serves as the essential building block for a diverse variety of
real-world applications such as social network analytics, data mining, network routing,
and scientific computing.

GraphAr is a project that aims to make it easier for diverse applications and
GraphAr (short for "Graph Archive") is a project that aims to make it easier for diverse applications and
systems (in-memory and out-of-core storages, databases, graph computing systems, and interactive graph query frameworks)
to build and access graph data conveniently and efficiently.

Expand Down
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@
'./.nojekyll',
]

html_title = 'GraphAr'
html_title = "GraphAr"
html_favicon = "images/graphar.ico"

html_show_copyright= True
html_show_sphinx = False
Expand Down
Binary file added docs/images/graphar-logo-notext.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/graphar-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions docs/images/graphar-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/graphar.ico
Binary file not shown.

0 comments on commit 137f121

Please sign in to comment.