I found reveal.js but I couldn't find a simple working example.
I found this but they are either too complex or cannot find the source.
Does anyone have a simple example?
The reveal.js repository on GitHub is in itself a demo for a simple presentation.
You can simply fork the project on GitHub, clone the fork to your local file system and edit the index.html file in the root directory to get started with your presentation.
I myself have created several presentations this way, most recently this one: https://github.com/pahund/devugees-prez-oct2017
If you create your presentation on a special Git branch named gh-pages, you can even view it online without having to deploy it to a server, for example: https://pahund.github.io/devugees-prez-oct2017/
If you don't want to install all the components (around npm) needed to use reveal.js, you can still use a docker image like agiled-de/reveal.js-docker
This images makes it easy to use reveal.js with docker. It supports the use of the following plugins:
MathJax Enables you to write LaTeX formulas in your presentations
reveal.js-menu Adds a menu to test themes, transitions and jump to slides
Chalkbord Write on your slides or on a chalkboard
Reveal.js-Title-Footer Adds a footer that will stay on every slide
Charts To create charts within your presentation
vis.js To create graphs in your presentation
And it has a demo_presentation/index.md included.
Related
I have seen a lot of docs websites that have the same layout or same features.
so I am wondering if there is a library used by all these docs.
how do they do this?
./docs -> files.md -> ./docs/files.html
like you see there are a lot of files with .md (sometimes also .mdx)
and they have the same functionalities (see below)
so I am wondering if they use the same js library to generate it?
I tried to search in all the repo, what they are using to generate, but nothing says the name of a library?
is there an npm package or CDN link to that js library?
that can get the .md files inside .docs, and based on the folder structure, create a list on the left with all topics, 2 buttons with next and previous, a button with edit this page on GitHub, etc...
if isn't possible I will do it by scratch, but writing HTML for every doc is time-consuming.
I prefer some markdown fast, build consistent docs, and automatically added to the first-page list on the left.
also the routing thing for getting previous and next elements I need to do it manually and this can be time-consuming.
is there something that does that for me, some web API that gets files .md if I need to do it from scratch?
but still prefering npm package if there is.
Example:
previous and next docs.
react native
deno
lusift
and they have a button with the text EDIT THIS ON GITHUB
Mozilla docs MDN
when scrolling, it will change the color of the currently viewed section
sketch API
but I never find the name of the library.
other functionalities are...
multi-page
and much more...
(I tried to search on Github, but never find it)
it's there a good docs generator for a programming library that I create?
I also google it: https://www.google.com/search?q=javascript+library+documentation
but nothing. the libraries there are for API GET/POST swagger etc...
but I am wanting a library for functions like if you write this function this happen, maybe also code snippet functionality to see what result give you that function.
something similar to StackOverflow. text to HTML (but not need any server-side things comlicated... just keep it simple the files are inside .docs in GitHub, so just simple stuff.
maybe I am writing wrong the google keyterm
I found the solution to this, by using the #evolutionxbox comment.
how to find?
if you want to find what library is used in a GitHub repo,
go to the package.json, there you can find the list of libraries that is used on the project
the name?
in this case, the library used is DOCUSAURUS
link: https://docusaurus.io/
is very simple to config and solves the job!
and is used by
Facebook,
and other big companies like:
supabase
redux
etc...
I have recently been working on a personal portfolio website. For this project, I have decided to implement the Three.js library. I have downloaded this library locally on my laptop. Locally, the website runs as intended. I am now at the stage in which I want to deploy the code into github pages. I have tried to add the Three.js library to the repository, however, Github says that there are too many files to add. This causes the HTML and CSS to load properly, however, there is a white screen in place of the Three.js scene.
How do I add the library to the repository, or is this even possible? I have also seen some information regarding using a CDN instead of uploading the library. If this is the optimal solution, how should I go about implementing this?
I'm fairly new on the React scene and just finished a few small react applications. I deployed two of these applications to Github Pages, and they both function perfectly.
However, I noticed that the files in my repository are minified. Not only that, but the language meter shows it as 100% html. It's nitpicky, but I'd like for it to display JavaScript/CSS too. I would greatly prefer my files be visible, just in case anyone wanted to look at how my application was built (mainly recruiters).
Is there some way to make these files visible/UNminified without sacrificing performance?
Is there any reason I wouldn't necessarily need to undertake this? --> (would employers care?)
You're committing your built project, but you should upload the source code!
To expose your github pages you have to build the project inside the docs folder, so you can have source code and build on the same branch!
So I'm trying to setup a portfolio page through Github pages, but want to use custom code instead of a Jekyll theme. My page is HTML, CSS, and JS and haven't found a solid solution yet. Is this possible and, if so, how do I go about this? Thanks!
Yes you can.
All you have to do is name your html file as index.html and publish it to the appropriate repository.
You have 2 options:
You either push your files in a gh-pages branch of the repository of your choice, if you have already setup your username.github.io or
You can go ahead and create a new reportsitory named username.github.io and push the code to the master branch.
Here's a link to a github help article
EDIT :
Specifically THIS 5-step tutorial describes exactly what you want to accomplish.
I'm creating Meteor app, I would like to use one of custom css frameworks i.e. Get Shit Done or Bootflat, but there are no packages for theme in Atmosphere.
Should I create those packages for my own or use standard approach by adding libraries using <link> tag?
Currently I tried second solution, but colors are incorrect.
Meteor will automatically detect CSS files. Just make sure you place them in the client folder. Organize your files according to the file load rules to get the correct hierarchy with your CSS files. Read about file loading here: http://docs.meteor.com/#/full/structuringyourapp
It would be nice though if you could place it in a package and keep it up to date on Atmosphere.
Why not just create your own package for the theme? that way you can use it in your own project and also share it on atmosphere. Here is a nice tutorial on how to create a package and use it locally as well as push it to atmosphere. Meteor package tutorial #meteorchef
Hope this helps!