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

mkdocs Website from readme #42

Merged
merged 8 commits into from
Aug 4, 2019
Merged

mkdocs Website from readme #42

merged 8 commits into from
Aug 4, 2019

Conversation

ivanminutillo
Copy link

Create a website with a standard theme from readme
In the following pull request there is also a dependency update, that may be not the case to add
I've updated lein-ring from 0.12.0 to 0.12.5 because it gave conflict with my leininingen version on mac.

Copy link
Contributor

@aspasia aspasia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, it look amazing. Apart from some small, probably not too important changes that I suggest I am ready to merge.

# SWAPI - Open source complementary currency toolkit

[![Build Status](https://travis-ci.org/Commonfare-net/social-wallet-api.svg?branch=master)](https://travis-ci.org/Commonfare-net/social-wallet-api)
[![Clojars Project](https://img.shields.io/clojars/v/social-wallet-api.svg)](https://clojars.org/social-wallet-api)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

somehow the build status doesnt show properly on site


extra:
links:
releases: https://files.dyne.org/redroom
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dont know how important but maybe those should be updated?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes all those you listed should be updated or some can be removed, they generate links on the page so they should be about swapi or like this one removed since there are no tarball releases of swapi

forum: https://lists.dyne.org
drift_handle: s64nd7w43g53
nav:
subtitle: Redis powered by Zenroom
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, different project references

@@ -0,0 +1,33 @@
site_name: Project-name
site_url: https://decodeproject.github.io/ProjectName
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, other project reference


extra:
links:
releases: https://files.dyne.org/projectname
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also be corrected


Example configuration:
```yml
site_name: RedRoom
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again Redroom

@@ -0,0 +1,101 @@
# Dyne.org theme for software webpages made in mkdocs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to checkin this file I wonder...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need, can either be a git submodule or leave a script there which clones the repo locally. Another option which I personally adopted while developing the theme is to symlink the git clone on my own filesystem.

site_name: Social Wallet
site_url: https://commonfare-net.github.io/social-wallet-api
repo_url: https://github.com/commonfare-net/social-wallet-api
site_author: Jaromil
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this to your name I would say

@aspasia aspasia merged commit df75d3f into develop Aug 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants