Code Monkey home page Code Monkey logo

howto's Introduction

ACDH-CH Learning resources

View content

Visit the website at https://howto.acdh.oeaw.ac.at.

Contribute content

Contribute or edit content via CMS

Sign-in to the CMS via [https://howto.acdh.oeaw.ac.at/cms]. You'll need a GitHub account and be a member of the ACDH-CH GitHub organization.

For edits to articles you can also directly click the "Suggest changes to this resource" links at the bottom of each post.

Run a local CMS backend

You can run a local CMS backend which writes directly to the filesystem, and does not require authentication, with yarn cms:dev. Then run either a production build of the website with NEXT_PUBLIC_USE_LOCAL_CMS='true' yarn build && yarn start or a development build with yarn dev and visit http://localhost:3000/cms. To apply the correct styles to the CMS preview, you will have to run yarn cms:styles once. Don't forget to commit and push changes via git.

Use your favorite text editor

Since content is saved to .mdx files in the content/posts folder, you can use your favourite text editor to make changes and commit via git. When using VS Code you can install the recommended extensions to get linting aud auto-formatting for markdown.

Contributing guidelines

When contributing content directly via git, please use feature branches and don't push to main, to allow for review.

Note on writing Markdown

Content is saved in MDX format, which is markdown with custom JavaScript components. Most markdown syntax is supported, however there are subtle parsing differences to be aware of. Most notably: the "lesser than" sign < needs to be HTML-escaped to &lt; (because it signifies the start of a custom component), and similarly "autolinks" (<https://example.com> instead of [https://example.com](https://example.com)) are not allowed.

howto's People

Contributors

stefanprobst avatar susannezhanial avatar fwiencek avatar ekoenigshofer avatar vera-charvat avatar sdrogies avatar timofruehwirth avatar bellerophons-pegasus avatar dasch124 avatar

Stargazers

tesang 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.