Code Monkey home page Code Monkey logo

alawit-from-morel's Introduction

Instructions to install the theme

Basic {#install}

  • Fork the repository. That is, create a copy in your Github account.
  • Open your system's terminal in the folder on your local computer where you will be working on the site. Mac and Linux have native terminals. For Windows, you will have to use WLS.
  • Run $ git clone http://github.com/[your_username]/morel-site-generator to clone the repository.
  • Run $ cd morel-site-generator to move to the repository folder
  • Run $ bundle update to update the theme and its dependencies. If you don't have Ruby on your system, follow the instructions in Jekyll
  • Run ruby dev.rb(alternatively, delete febr3s.github.io/morel-theme-generator from the remote_theme: line in _config.yml)
  • Run $ bundle exec jekyll serve --config _config.yml,_config_local.yml --livereload to run the test site.

Customize {#configure}

Now you have on your local computer a ready-made site with sample content, from the MOREL site Afro Latin American Writers in Translation (ALAWiT). You can run it locally to test with $ bundle exec jekyll serve --config _config.yml,_config_local.yml --livereload.

To fill it with your site's information, follow these steps:

  • Open _config.yml in your text editor and change:
    • The title to your site's.
    • The tagline to your site's.
    • The email and/or social media accounts to your site's.
    • The jotform link (create your free account at https://www.jotform.com/).
  • Open the file _about/site-description.md and write a description for your site. The <!-- more --> line splits what is shown on the footer of all your pages from what is shown both in the footer and only on the about page. For this to work you have to complete the final step of this section
  • Replace the logo, pattern and avatar files by adding a file to:
    • assets/img/tema/logo.png
    • assets/img/tema/avatar.jpg
    • assets/img/tema/trama.png
  • Open the podcast.md file and change the title and tagline of your podcast or blog.
  • The _posts folder has the MOREL posts. Delete the MOREL posts and create your own with Jekyll nomenclature. If you don't want to add any podcast posts or episodes to your site, change in _config.yml the podcast value to false
  • Run the site locally with $ bundle exec jekyll serve --config _config.yml,_config_local.yml --livereload
  • Open the _site folder and copy the file site-description.htmlto the _includesfolder

Generating the content from Zotero {#generate}

  • Run $ jekyll build --config _config_local.yml to import to the _sites folder the updated content generators.
  • Run $ unzip -d ./assets/ ./_site/assets/env.zip to update the Python environment that generates the contents.
  • Open Zotero and review the guide at the end of this instructions to make the fields 100 % readable for MOREL.
  • Export your Zotero collection as csv. If you don't know how to do it follow the instructions here.
  • Name your csv file as books_zotero.csv. Replace the file of the same name found in the assets/data folder.
  • Run $ cd assets/env/bin to go to the folder where the Python environment is activated. Activate it with $ source activate.
  • Run $ cd ../src to move to the folder where the Python scripts are located.
  • Run $ python3 morel-generate.py to generate the content from your Zotero collection. In some operating systems, the command might vary. Check the Python documentation for guidance
  • Run cd ../../..to go to the root folder of the site
  • Run rm ./assets/envto remove the python environment until the next update
  • Run $ bundle exec jekyll serve --config _config.yml,_config_local.yml --livereload to activate the local server for browsing.
  • Open the browser and go to the link provided by the local server (usually it's http://127.0.0.1:4000).
  • Browse your custom site!

Deploy {#publish}

  • Run $ ruby prod.rb(alternatively, add febr3s.github.io/morel-theme to the remote_theme line:)
  • To publish to Github, follow their instructions (ignore the "New repository" step as you are working with your MOREL fork).
  • To publish with a third party, follow Jekyll's instructions.
  • To publish to your personal server follow Jekyll's instructions.

To install the theme as a local Ruby gem, or without code

We are working on instructions and utilities to facilitate these possibilities.

Subscribe to one of our channels to stay updated {#suscribe}:

">https://chimpstatic.com/mcjs-connected/js/users/8aec37d971cdc280e8f9eb567/1a19782d38e75f439e3d5a1fd.js");</script>-->

Zotero fields {#zotero-fields}

MOREL items are added in the same way that items are added in any Zotero library. In its current version, MOREL can only process items of type book. Since not all the fields needed for MOREL are available for the book content type, some considerations must be made:

  • Excerpt: the fragment from each MOREL record corresponds to the notes of Zotero (see the [documentation] of the notes (https://www.zotero.org/support/notes) of Zotero). In its current version, MOREL only accepts one excerpt per book.
  • Cover: the cover is a jpg file that is added as an attachment to the Zotero item (see the Zotero attachments documentation).
  • Translation or original: in order to filter translated books from originals, MOREL uses Zotero's Series field to indicate whether it is a translation with the tr sign.
  • First edition: MOREL uses the Date field for the date of publication of the book and the Edition field for the date of first edition.

alawit-from-morel's People

Contributors

febr3s avatar conpulsi0n avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.