Coder Social home page Coder Social logo

Comments (6)

hawkerm avatar hawkerm commented on August 11, 2024

Feel free to check out my config file I use for Space Battle here: https://github.com/Mikeware/SpaceBattleArena/blob/master/_config.yml

I set it up, so I can use the gh-pages repository to host on GitHub and have it read from the doc folder of my main project's markup.

from teals-minecraft.

hollasch avatar hollasch commented on August 11, 2024

@hawkerm It doesn't look like you're using Jekyll any more. Am I correct in thinking it's just HTML now?

from teals-minecraft.

hawkerm avatar hawkerm commented on August 11, 2024

@hollasch curious, what makes you say that? Jekyll compiles down to HTML in the end, so to the browser it's just a collection of HTML pages. But in the back-end of my doc repro it's all markdown.

I need to resetup my tool chain on my new machine now though...

from teals-minecraft.

hollasch avatar hollasch commented on August 11, 2024

Interesting, looks like you have a non-standard setup, where your doc sources are in master in the docs/ directory, and your gh-pages branch contains the generated HTML output. The standard GitHub Jekyll setup is to put Jekyll configuration and source *.md files in the gh-pages branch (or now, the docs directory), and GitHub auto-generates the resulting HTML site on the fly, served to the project web site.

That said, getting Jekyll and its requirements to run in a PC environment was painful enough that I wrapped up my experiment after a day of fiddling, as it would require a fussy setup for every other author who wanted to view results locally as they develop new materials.

from teals-minecraft.

hollasch avatar hollasch commented on August 11, 2024

I'm going to table this for now.

from teals-minecraft.

hawkerm avatar hawkerm commented on August 11, 2024

@hollasch good to know about the GitHub auto-generate. I was setting it up in my master so I could move docs alongside the code as I made changes, generate locally to ensure docs looked good, and then push to the docs branch the changes that snapped to the code when I made a new release.

from teals-minecraft.

Related Issues (19)

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.